Hierarchische Dokumentation von Objekten

Wie wird es gemacht ?
Wenn ein Vorgang beschrieben wird, beginnt man mit einem einleitenden Satz. Er hilft innerhalb des Pflichtenheftes festzustellen, von wo der Vorgang aufgerufen bzw. wo er ausgelöst worden ist. Der Kontext ist so einfacher ersichtlich. Der einleitende Satz ist hierbei als Minimalanforderung an den Einsteig in eine Vorgangsbeschreibung 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> / der Funktion <Funktion > wird der folgende Vorgang <Name des Vorgangs> abgearbeitet:

Beispiel:
Durchführen der Preisermittlung bei der Auftragserfassung
Währung feststellen
Im Auftragskopf kann pro Auftrag individuell eine Währung hinterlegt werden. Voreingestellt ist die Währung aus dem Kundenstamm. Zur Ermittlung der korrekten Preisliste wird die Währung aus dem Auftragskopf herangezogen.
Preisliste feststellen
Im Kundenstamm sind die Preislisten des Kunden hinterlegt. Für den aktuellen Zeitraum wird die gültige Preisliste unter Berücksichtigung des Währungskennzeichens ermittelt.
Preisliste konnte nicht ermittelt werden
In diesem Falle werden bei den Artikeln keine Preise vorgeblendet.
Sie müssen manuell erfasst werden.
Ende der Preisermittlung (Manuelle Preise)
Preisliste konnte ermittelt werden
Abhängig von der erfassten Menge wird der Preis aus der Preisliste
vorgeblendet. Bei Einzelbestellung greift der Stückpreis. Bei Bestellungen
von mehr als einem Stück wird die Mengenstaffel bei der Preisermittlung
berücksichtigt.
Ende der Preisermittlung (Preise gemäß Preisliste)

Die Struktur der Auflistung zeigt, dass es eine Überschrift und eine kurze Beschreibung gibt. Diese Struktur erlaubt es, sich schnell in den jeweiligen Schritten der Verarbeitung zurecht zu finden. Werden keine Überschriften gemacht, muss man erst den gesamten Text lesen, bis man das Richtige gefunden hat.

Sollten die Verarbeitungsschritte des Vorgangs nur aus Überschriften bestehen, fällt es u. U. schwer nach einer gewissen Zeit den Gesamtumfang bzw. den Inhalt des Vorgangs zu erkennen. Aus diesem Grunde sollte die Darstellung der Verarbeitungsschritte immer aus beiden Elementen bestehen. Nutzen Sie zur besseren visuellen Abgrenzung der einzelnen Überschriften Aufzählungszeichen.

Bei der Textdarstellung von Vorgängen mit Abfragen sollten die zusammengehörigen Schritte einer Abfrage auf einer Ebene zusammengefaßt werden.

Start

Verarbeitungsschritt 1

Verarbeitungsschritt 1a

Verarbeitungsschritt 1b

Verarbeitungsschritt 2

Abfrage 1

Verarbeitungsschritt 3

Ende

Verarbeitungsschritt 4

Verarbeitungsschritt 5

Ende

Die Darstellung der Gliederung zeigt, daß die rein textuelle Darstellung nur bedingt geeignet ist, komplexe Vorgänge zu beschreiben. Ein Bild sagt in diesen Fällen doch mehr als tausend Worte.