Hierarchische Dokumentation von Objekten

Worum geht es?
Jede Anwendung, die Daten in Form von Belegen herausgibt, kann diese Belege mit Hilfe des Objektes Ausgabe beschreiben. Das Objekt Ausgabe ist zur Beschreibung von Listen und Formularen vorgesehen. Hierbei beschränkt sich die Ausgabe nicht alleine auf Text. Neben der textuellen Ausgabe können hier auch Grafiken beschrieben werden.

Außer der Ausgabe von Belegen kann eine Anwendung natürlich noch Ausgaben in Form von Filmen und Tönen ermöglichen. Die Pflichtenhefterstellung erfolgt jedoch zumeist in Form von Textdokumenten. Durch die Unterstützung von OLE ist es natürlich möglich, solche Elemente mit in die Beschreibung aufzunehmen. Allerdings wird es in diesen Fällen mit dem Ausdruck etwas schwierig. Damit die Möglichkeit besteht, alle Ausgabemöglichkeiten einer Software unter einem einheitlichen Begriff zu beschreiben, werden alle Ausgaben global als Ausgabeobjekte bezeichnet.

Speziell bei den Anforderungen an den Aufbau und den Informationsgehalt der Ausgabeobjekte herrscht bei den Anwendern vielfach die Meinung vor, dass ein Beleg „unendlich“ viele Informationen aufnehmen kann. Diese Erkenntnis ist um so ärgerlicher, wenn erst bei der Programmierung festgestellt wird, dass der Beleg nicht in der angedachten Form umgesetzt werden kann.

Als Grund für solch eine Situation ist zumeist das fehlende Design während der Pflichtenhefterstellung anzuführen. Vielfach werden als Realisierungsinformation nur die Felder aufgeschrieben, die der Beleg enthalten soll. (Alles andere soll sich dann schon während der Programmierung von selber regeln....)

Für eine kostengünstige Realisierung von Ausgabeobjekten ist das Design der Belege bei der Erstellung des Pflichtenheftes unerlässlich! Die einfachste Möglichkeit, das Design eines Ausgabeobjektes zu prüfen, ist die Erstellung einer 1:1 Abbildung. Als Werkzeug für diese Aufgabe hat WinWord in der Vergangenheit gute Dienste geleistet. Zentrales Kriterium für das erfolgreiche Design von Belegen ist die Beantwortung folgender Frage:

„Können alle gewünschten Informationen in der vorgesehenen Form auf dem Beleg ausgegeben werden?“

Wie die Datei wird auch das Ausgabeobjekt als Endpunkt einer Funktion bzw. eines Ablaufs angesehen. Aus diesem Grunde kann das Ausgabeobjekt auch keine untergeordneten Objekte haben. Für die Beschreibung im Pflichtenheft bedeute dies, dass es unter dem Kapitel zur Beschreibung eines Ausgabebeleges keine weiteren Kapitel geben kann, die mit dem Ablauf des Programms zu tun haben. (Die genaue Erläuterung dieser Sichtweise finden Sie im Handbuch von HDvO)

Was bringt es?
Die meisten Softwaresysteme produzieren Belege in der einen oder anderen Form. Aus diesem Grunde ist es notwendig, Inhalt und Aufbau dieser Belege vollständig zu beschreiben. Erst mit der vollständigen Beschreibung aller von der Software getätigten Ausgaben ist das Pflichtenheft komplett.

Zudem wird beim Design von Belegen schnell festgestellt, ob sich die gewünschten Informationen in der gewünschten Form auf dem jeweiligen Beleg unterbringen lassen. Sollte das Design der Belege unterlassen werden, kann der Fall auftreten, dass die später produzierte Form in Gestaltung und Informationsgehalt nicht die gewünschten Ergebnisse liefert.

In vielen Fällen wird erst mit der Erstellung des Beleges festgestellt, welche Informationen insgesamt auf dem Beleg ausgegeben werden müssen. Damit dieser Effekt erzielt wird, sollte der zukünftig vom System erstellte Beleg dem Originalbeleg so nahe wie möglich kommen.

Beim Design von Belegen gilt folgende Regel:

Kosten sparen – Standards nutzen!

Dieser Grundsatz lässt sich auch auf alle anderen Bereiche bei der Softwareentwicklung anwenden. Doch gerade bei diesem Thema gibt es ein großes Einsparungspotential, wenn hier auf unnötige Individualität beim Drucklayout verzichtet wird.

Gerade Belege, die das Unternehmen verlassen, sollten ein einheitliches Erscheinungsbild vorweisen. Aus diesem Grunde sollte die Gestaltung dieser Belege auch nicht an die Entwicklung delegiert werden. Wie bei der Diskussion um die Abbildung eines Dialoges in einem Pflichtenheft sind wir auch bei der Beschreibung der Ausgabebelege der Meinung, dass die Abbildung des Belegs in einem Pflichtenheft unverzichtbar ist.

Neben der Möglichkeit, über Belegdesigner oder Grafikprogramme einen Ausgabebeleg darzustellen, besteht auch die Möglichkeit, bereits existierende oder extern erstellte Ausgabebelege einzuscannen. Grundsätzlich gilt, je exakter die Darstellung der Belege im Pflichtenheft den zukünftigen Ausgaben entsprechen, desto geringer werden Diskussionen über evtl. Nacharbeiten sein.

Die Beschreibung eines Beleges teilt sich immer in zwei Teile. Der Abbildung des Beleges und der Feld- und Layoutbeschreibung. Sollte das Abbild des Beleges eingescannt sein, achten Sie darauf, das durch eine zu hoch gewählte Farbtiefe die Dokumentation nicht über Gebühr aufgebläht wird.

Wie bei der Beschreibung von Dialogen ist die Systematik der Beschreibung im Bereich der Feld- und Layoutbeschreibungen von Ausgabebelegen unabhängig von der Art der Anwendung und dem zugrundeliegenden Betriebssystem zu sehen. D. h. für die Beschreibung von Belegen muss keine betriebssystemspezifische Form der Beschreibung erstellt werden.

Wenn ein Ausgabeobjekt beschrieben wird, beginnt man mit einem einleitenden Satz. Es hilft innerhalb des Pflichtenheftes festzustellen, von wo das Ausgabeobjekt aufgerufen worden ist. Der Kontext ist so einfacher ersichtlich. Der einleitende Satz ist hierbei als Minimalanforderung an den Einstieg in eine Beschreibung 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> wird die <Name des Ausgabeobjektes> ausgedruckt.“ Bei Listen, die automatisch z. B. im Tagesabschluss gedruckt werden könnte der Satz lauten: "Im Tagesabschluss wird die nachfolgende <Name der Ausgabeobjektes > ausgedruckt.“