Hierarchische Dokumentation von Objekten

Worum geht es?
Das Objekt Datei dient zur Beschreibung von Dateistrukturen. Es wird immer dann benötigt, wenn Daten von außen in die Anwendung hinein laufen bzw. aus ihr heraus erzeugt werden sollen. In beiden Fällen hilft dieses Objekt, eine genaue Tabellen- bzw. Datensatzbeschreibung zu erstellen. Die Beschreibung ist in diesem Zusammenhang als Beschreibung einer Tabelle zu verstehen, sie ersetzt kein Datenmodell.
Innerhalb der Methode HDvO wird das Objekt Datei als Endpunkt einer Funktion bzw. eines Ablaufs angesehen. Aus diesem Grunde kann dieses Objekt keine untergeordneten Objekte haben. (Die genaue Erläuterung dieser Sichtweise finden Sie im Handbuch von HDvO)

Was bringt es?
Wenn Pflichtenhefte für Softwaresysteme geschrieben werden, die Daten mit anderen Systemen austauschen, dann ist die eindeutige Beschreibungen der Schnittstellen (Ein- und Ausgabedateien) eine elementare Voraussetzung für eine funktionsfähige Software.

Wie wird es gemacht?
Zur Beschreibung von Dateistrukturen haben sich Tabellen bewährt. Rein textuelle Beschreibungen lassen zuviel Raum für Interpretationen. Sie sind in der Programmierung unter ökonomischen Gesichtspunkten u. E. nicht einsetzbar. Die hier vorgestellte Tabellenstruktur ist als minimale Anforderung an die Beschreibung einer Datei zu sehen.
Wenn eine Datei beschrieben wird, beginnt man mit einem einleitenden Satz. Es hilft innerhalb des Pflichtenheftes festzustellen, von wo die Datei kommt bzw. wohin sie geht. Der Kontext ist so einfacher ersichtlich. Der einleitende Satz ist hierbei als Minimalanforderung an den Einsteig in eine Dateibeschreibung zu sehen. Wenn zusätzliche Erklärungen sinnvoll sind, sollten Sie hier an dieser Stelle gemacht werden.
Der einleitende Satz für eine Ausgabedatei könnte lauten: "Nach Aufruf des Menüpunktes <Menüpunkt> wird die Datei <Name der Datei> ausgegeben.

Nr
Fortlaufende Nummer des Tabelleneintrags.

Von-bis
Länge des Datensatzes. (Achten Sie darauf, daß die verschiedenen EDV-Systeme eine unterschiedliche Basis für die Bestimmung der Länge eines Datensatzes verwenden. Einige Systeme beginnen bei 0 andere bei 1 zu zählen.)

Typ
Typ des übergebenen Datenfeldes. (Character, Num, Integer usw.) Wegen der Vielfalt der Möglichkeiten einen Datentyp zu beschreiben, haben wir auf eine Auflistung verzichtet. Nutzen Sie zur Beschreibung Ihrer Dateien, die Notation Ihres Quell- bzw. Zielsystems.

Länge
Die Länge des Feldes. (z. B. 40) (Bitte informieren Sie sich vor der Beschreibung von Dateien genau über die Arbeitsweise der beteiligten Datenbanken. Die Zählweise für die Datensatzlänge ist u. U. unterschiedlich. Einmal ist die Länge eines Feldes incl. Dezimalstellen zu verstehen, ein anderes Mal wird sogar der Dezimalpunkt mit als Stelle gezählt. Wieder andere Systeme zählen die Dezimalstellen bei der Bestimmung der Gesamtlänge des Feldes nicht separat.)

Dezimale
Anzahl der Nachkommastellen bei numerischen Feldern.

Name
Technischer Name des Feldes. (z. B. KDNR für Kundennummer)

Beschreibung
Eine kurze Beschreibung des Feldes. (Hier kann neben der Beschreibung auch der fachliche Namen des Feldes stehen)

Bei solch einer Tabelle bietet es sich an, diese Beschreibungen in Excel zu verwalten. Sinnvollerweise würde die Excel-Tabelle dann als OLE-Objekt mit dem Pflichtenheft verknüpft. Damit wäre eine automatische Aktualisierung sichergestellt, wenn sich die Excel-Tabelle ändert. Es hat sich allerdings bei unserer Arbeit gezeigt, dass ab einer gewissen Größe die Bearbeitung eines Pflichtenheftes zur Qual wird, wenn zu viele verknüpfte OLE-Objekte im Dokument vorhanden sind. Das Dokument wird beim Öffnen und Abspeichern sehr träge. Wählen Sie daher für das Arbeiten mit Excel-Tabellen die Option "Einfügen" aus. Damit ist zwar keine automatische Aktualisierung der Objekte bei Änderungen der Tabellenstrukturen gegeben, jedoch gestaltet sich das Arbeiten mit dem Pflichtenheft angenehmer. Um Probleme mit OLE-Verknüpfungen zur vermeiden, können wir nur raten: "Halten Sie immer von jedem OLE-Objekt eine separate Kopie bereit!" So können Sie bei fehlerhaften Verknüpfungen bzw. beschädigten Objekten immer noch über Excel auf Ihre Arbeitsergebnisse zurückgreifen. Dieser Rat gilt übrigens auch für alle anderen Anwendungen, die OLE-Objekte innerhalb von Word abspeichern können.

Beschriftung der Dateibeschreibung
Die Dateibeschreibung sollte als eigener Gliederungspunkt im Pflichtenheft erscheinen. So können die Verantwortlichen für die Schnittstellenprogrammierung schnell auf die für sie notwendigen Informationen zugreifen. Verwenden Sie als Überschrift neben dem technischen Namen der Tabelle auch eine textuelle Umschreibung (statt einfach nur "KDSERTXT" zu schreiben sollte die Überschrift der Tabelle mit "Serientextdatei Kundenstamm (KDSERTXT)" beschriftet werden.

Besonderheiten bei Datenbanksystemen
Manche Datenbanken haben zusätzliche Besonderheiten, die bei der Beschreibung von Dateien beachtet werden müssen. So kann z. B. die Datenbank der AS/400 nur feste Satzlängen verarbeiten. Bei der Generierung von Ausgabedateien, die solch einer Datenbank zur Verfügung gestellt werden, müssen alle Felder auf die maximale Länge aufgefüllt werden. Diese und andere Informationen müssen vor der Beschreibung der Dateien aufgeführt werden.

Objektorientierte Datenbanken
Die Systematik Daten zu speichern, ist bei objektorientierten Datenbanken anders als bei relationalen Datenbanksystemen.
Bei Beschreibung von Tabellen objektorientierter Datenbanken muss anders vorgegangen werden. Hier müssen u. a. zusätzlich noch die Methoden des Objekts beschrieben werden, die mit in der Datenbank abgelegt werden. In unserer Arbeit mit kaufmännischen Applikationen ist uns diese Formen der Datenbank bisher noch nicht begegnet. Wir werden bei Bedarf diese Beschreibung nachreichen.