Hierarchische Dokumentation von Objekten

Worum geht es?
Mit dem Menü werden alle Auswahlmöglichkeiten innerhalb eines Programms beschrieben. Hierzu gehören neben den Menüpunkten bei grafischen Oberflächen auch die Buttonleisten (Toolbars). Sie stehen zumeist als Ersatz bzw. Ergänzung für diese Menüpunkte innerhalb einer Anwendung zur Verfügung. Bei zeichenorientierten Oberflächen können anstelle von Symbolleisten Funktionstasten bzw. Tastenkombinationen (Hot-Keys) die Aufgabe der Buttons in den Symbolleisten übernehmen.

Menüs sind losgelöst von Dialogen zu sehen. So werden Buttons bzw. Tastenkombinationen, die nur innerhalb von Dialogen zur Verfügung gestellt werden nicht als eigenständige Menüs beschrieben. Der Grund für diese Teilung ist, daß mit Hilfe von Menüs die Funktionalität der gesamten Anwendung gesteuert werden. Die Buttons/Tasten innerhalb von Dialogen steuern jedoch nur die Funktionalität des Dialogs. Aus diesem Grunde werden sie innerhalb des Dialogs beschrieben.

Was bringt es?
Menüs bieten eine gute Möglichkeit bei einem Pflichtenheft als Gliederungshilfe zu dienen. Dies hat zum einen den Vorteil, daß man nicht (irgend)eine andere Gliederungsform suchen muss. Zum anderen kann sich die Fachabteilung an der technischen Umsetzung der zu entwickelnden Software orientieren.

Wie wird es gemacht?
Nachfolgend wird das Hauptmenü unserer Software HDvO gezeigt.

Entsprechend dieser Menüstruktur sieht eine Gliederung, die eine Menüstruktur als Vorlage nimmt wie folgt aus:

1. Projekt
2. Bearbeiten
3. Objekt
4. Ansicht
5. Fenster
6. Hilfe

Die Unterpunkte unter dem jeweiligen Hauptmenüpunkt bilden dann die nächst niedrigere Gliederungsstufe. Ein Menüpunkt kann nicht nur weitere Untermenüpunkte aufrufen. Sobald Funktionen ausgeführt werden, beginnt die Leistungsbeschreibung des Programms.

Die Beschreibung von Menüpunkten ist erfreulich kurz. Im obigen Beispiel würde sie für den ersten Punkt lauten:

Projekt
Unter den Menüpunkt Projekt sind alle Funktionen zusammenfasst, die die Bearbeitung von HDvO-Projekten betreffen. Dieser Menüpunkt ist immer verfügbar.

Name des Menüpunktes
Exakte Beschreibung des Menüpunktes, wie er später im Programm auftauchen wird. Bei grafischen Oberflächen, wie z. B. Windows gibt es Konventionen zur Beschriftung von Menüpunkten. (z. B. "->" hinter Menübeschriftungen, wenn ein Menüpunkt ein Untermenü aufruft) Diese Konventionen sollten Bestandteil des Menünamens sein.

Beschreibung
Die Beschreibung eines Menüeintrages entspricht im wesentlichen dem Hilfetext, der bei vielen Windowsanwendungen in der Statuszeile des jeweiligen Programms angezeigt wird.

Zusätzliche Informtionen zur Beschreibung eines Menüpunktes
Zusätzlich zu dieser Beschreibung kann eine Bedingung hinzugefügt werden. Zum einen kann ein Menüpunkt nur innerhalb eines bestimmten Kontextes verfügbar sein. (z. B. ist der Menüpunkt "Drucken" nur dann verfügbar, wenn auch ein Dokument geladen worden ist) Zum anderen kann der Aufruf eines bestimmten Menüpunktes an Berechtigungen geknüpft sein. (z. B. Der Menüpunkt "User löschen" ist nur dann verfügbar, wenn der Anwender die Rechte des Administrators hat.) Falls die Verfügbarkeit des Menüpunktes an mehreren Bedingungen hängt, sollte die textuelle Beschreibung durch eine Tabelle ersetzt werden.

Unser Vorschlag

Aktiv	Bedingung	Meldung
JA	Der Anwender muss die Rechte des Administrators haben
JA	Es muss mindestens ein User eingetragen worden sein.	"Es konnte kein User gefunden werden."
NEIN	In allen anderen Fällen ist der Menüpunkt inaktiv.	"Diese Funktion kann zur Zeit nicht genutzt werden."

Aktiv
Ist der Menüpunkt bei der nachstehenden Bedingung aktiv?

Bedingung
Welche Bedingung wirkt auf den Menüpunkt ein?
(Prüfen Sie, ob es u. U. verknüpfte Bedingungen gibt. Z. B. kann der Menüpunkt "Ware ausliefern" immer dann gesperrt sein, wenn ein Kunde noch offene Rechnungen hat. Sollte er aber diesen Auftrag per Vorkasse bezahlt haben, wird die Ware dennoch ausgeliefert.)

Meldung
In bestimmten Systemen werden Menüpunkte nicht inaktiviert, sondern es erfolgt bei Auswahl eine Meldung, warum dieser Punkt nicht ausgeführt werden kann. In diesem Fall kann hinter der Bedingung der Meldungstext eingetragen werden, der dem Anwender angezeigt wird, wenn er den Menüpunkt aufruft.

Rechte Maustaste
Bei vielen grafischen Benutzeroberflächen besteht die Möglichkeit, die rechte Maustaste zu nutzen um ein kontextsensitives Menü aufzurufen. Die Beschreibung einer solchen Funktion sollte nicht an dieser Stelle erfolgen. Die Funktion der rechten Maustaste wird innerhalb eines bestimmten Kontextes genutzt. Aus diesem Grunde sollte die Beschreibung dieser Funktionen auch an der Stelle des jeweiligen Kontextes erfolgen. Unseren Vorschlag finden Sie unter dem Punkt "Dialoge - Rechte Maustaste".

Detaillierungsmöglichkeiten der Beschreibung
In verschiedenen anderen Bereichen der Dokumentation von Programmfunktionen besteht die Möglichkeit, bei der Beschreibung verschiedene Arten der Detaillierung zu wählen. Wir haben sie mit klein, mittel und groß bezeichnet. (In Anlehnung an den zu treibenden Arbeitsaufwand diese Informationen niederzulegen.) Hier an dieser Stelle sehen wir keine Möglichkeit/Notwendigkeit, diese Varianten anzubieten. Die Substanz der Beschreibung von Menüs ist zu gering, als das sich die Differenzierung des Detaillierungsgrades bei der Beschreibung lohnen würde.