FREIBURG (je) - Eine Art Rentenversicherung wollen sich manche Programmierer oder Sofware-Häuser verschaffen, indem sie den Anwender zwar mit Applikationssoftware nicht aber mit sauberer Dokumentation beliefern und somit im Wartungsfall "unentbehrlich" sind. Dies mutmaßt Rainer Weyh, Mitgeschäftsführer der Freiburger EDV-Beratung Kühn & Weyh GmbH. Gegen Mißstände dieser Art bieten die Freiburger für Anwender des IBM /34-Systems die automatische Programm-/Prozedurendokumentation "XD034" an.
Weyh sieht am europäischen Markt derzeit kein vergleichbares Dokumentationssystem. Seit Vertriebsbeginn im November vergangenen Jahres hat es insgesamt acht Installationen von XD034 gegeben, und zwar in Deutschland, der Schweiz, Osterreich und Italien. Weyh konstatiert eine steigende Bedeutung der Programmdokumentation und nennt als Ursachen, daß immer mehr Programmierkapazität in Änderungen aufgezehrt wird und daß gesetzliche Auflagen eine aussagekräftige Dokumentation vorschreiben.
Neuprogrammieren scheinbar produktiver
Die tägliche Praxis wird diesen Anforderungen nach Ansicht Weyhs aus folgenden Gründen nur unzureichend gerecht: Die knappen Programmierressourcen werden lieber für die Erstellung neuer Programme eingesetzt, da hieraus eine sichtbare Produktivität resultiert; für die Dokumentation bleibt dann kaum mehr Zeit übrig. Es scheint, glaubt er, außerdem der Mentalität vor allem guter Programmierer entgegenzustehen, die ungeliebte Arbeit "Dokumentation" auf sich zu nehmen.
Auf dem Markt der Basisdatenverarbeitung, analysiert Weyh, sind die Anwender oft EDV-Laien, die die Notwendigkeit und Korrektheit einer Dokumentation gar nicht vollständig erkennen können; demzufolge erstellten einige hier tätige Programmierer und Software-Häuser häufig keine oder eine unzureichende Dokumentation. Hierbei spiele vielleicht manchmal die Hoffnung mit, aus einmal, erstellten Programmen durch künftig gewünschte Änderungen/Erweiterungen eine "Rentenversicherung" zu haben oder sich unentbehrlich zu machen.
Abhilfe - so Weyh- können nur Dokumentationshilfen schaffen, die automatisch, ohne Mitwirkung des Programmierers eine umfangreiche Dokumentation liefern. Als Eingabe für solche Programme sollten lediglich die Quellenprogramme und Prozeduren dienen.
Die bisher bekannt gewordenen Dokumentationssysteme hatten jedoch einen entscheidenden Nachteil, behauptet Weyh: Sie benutzen als Informationsquellen nur die Quellenprogramme, nicht jedoch die Prozeduren Da die Prozedurensprache aber beim System /34 sehr mächtig sei, könne gerade hier das Zusammenspiel der Menüs, Prozeduren und Programme sowie der Bedingungen, die sie aktivieren sehr komplex und damit undurchsichtig und schwierig änderbar werden.
Weyh: "Es gibt so gut wie noch nichts, was Prozeduren dokumentiert oder gar eine ganze Prozedurenhierarchie, in der eine Prozedur eine andere aufruft." Wichtig ist dies aber auch deshalb, meint der Software-Experte, weil ansonsten der Zusammenhang zwischen den physischen Dateien (Dateinamen auf der Platte oder Diskette) und den Dateinamen in den Programmen nicht sichtbar wird. Dies sei vor allem für den Operator wichtig, da er beispielsweise sonst nicht die Konsequenzen von Wiederholungsläufen endgültig übersehen könne.
XD034 - so Weyh - löst diese Probleme, indem es der Dokumentation die Prozeduren zugrunde legt und (soweit symbolisch in RPG II oder WSU vorhanden) Informationen aus den Quellenprogrammen (File- Bestimmungen) ergänzend zu Hilfe nimmt. Darüber hinaus werden auch DFU-Abrufe (ENTER, UPDATE, LIST, INQUIRY) unterstützt, also in die Dokumentation einbezogen.
XD034 besteht aus den Komponenten Menü- und Prozedurendokumentation, Dateiverwendungsnachweise auf Prozeduren- und Programmbasis sowie als Zusatzmodul der grafischen Programmdarstellung. Diese Komponenten liefern dem Anwender folgende Informationen: Menüdokumentation: Es werden zunächst alle Menüs (entnommen der Quellenbibliothek) so gelistet, wie sie sich dem Anwender darstellen, und zwar sowohl Fest- als auch Freiformat-Menüs. Hinter jedem Menü wird die Auflösung dargestellt, also der sich hinter der Menüposition verbergende Befehl.
Prozedurendokumentation: Jede in der Anwendung definierte Prozedur wird hier aufgelistet. Um die Aufruf-Hierarchie sinnvoll darzustellen und auch, um das Problem der sich selbst aufrufenden Prozeduren in den Griff zu bekommen, wird hier eine stücklistenähnliche Darstellung verwendet. Je Prozedur werden gelistet: alle Prozeduren, die diese Prozedur aufruft, eventuell Programme, die von der Prozedur aufgerufen werden (als unterste Hierarchie-Ebene) sowie alle Prozeduren oder Menüs (einschließlich Positionsnummer), von denen diese Prozedur aufgerufen wird.
Hierdurch, faßt Weyh zusammen, ist eine Darstellung der Aufruf-Hierarchie jeweils nach oben und unten gewährleistet. Beim Ausweis der aufgerufenen Prozeduren sei noch vermerkt, ob es sich jeweils um Systemprozeduren (wie RESTORE, DELETE und so weiter) oder um externe Prozeduren handelt, die nicht in der Benutzerbibliothek gespeichert sind. Die Prozedurenübersicht wird abgeschlossen durch eine Listung aller Programme (gemäß // LOAD) mit dem Ausweis der sie aufrufenden Prozedur(en).
Dateiverwendungsnachweis: Es erfolgt eine Listung jeder in der Anwendung verwendeten Datei-Wahlweisgemäß Prozedur (also LABEL-Name) oder gemäß RPG- oder WSU-Programm: Dazu Weyh: "Angenommen, das System bricht zusammen, oder der Operator macht einen Fehler, muß wieder ,aufsetzen' und schaut dafür in die Dokumentation, dann ist nicht unbedingt gewährleistet, daß er diejenigen Dateinamen im Programm findet, die auch auf der, Platte stehen, weil man die nämlich über eine LABEL-Karte verändern kann."
Verbal-Dokumentation
XD034 - so Weyh - verquickt die Programmnamen mit den Labels auf der Platte und liefert derart folgende Informationen:
Dateiname gemäß Prozedur, Dateiname gemäß Programm, Art der Verwendung (INPUT, OUTPUT, CHAIN, DEMAND, OUTPUT-ADD etc.), Name des verwendenden Load-Programms, Name der aufrufenden Prozedur sowie Anzahl Sätze, sofern bei Ausgabedateien der RECORDS-Parameter verwendet wird. Diese letzte Information, meint Weyh, stellt eine wesentliche Hilfe dar, wenn Dateien zu klein werden und alle betroffenen RECORDS-Parameter vielleicht mühsam gesucht werden müßten, um verändert werden zu können.
Der Dateiverwendungsnachweis, resümiert Weyh, ist nicht nur nach Dateien, sondern auch nach Programmen abrufbar, was einen komprimierten Überblick über den Datenfluß je Programm verschaffe. XD034 unterstütze auch den Einsatz der Message-Member-Funktion für Dateinamen und RECORDS-Angaben. (Siehe zu diesem Abschnitt die Abbildungen 3 und 4.)
Grafische Programmdarstellung: Neuerdings steht noch ein Zusatzmodul "XD034-DB" zur Verfügung, der vor allem eine "optische" Verbesserung der Dokumentation liefern soll. Aus den Quellen-RPG- oder -WSU-Programmen wird eine grafische Darstellung der je Programm verwendeten Dateien und Ein-/Ausgabeeinheiten geliefert. (Siehe dazu auch Abbildung 5.)
Dieser Dokumentationsmodul entnimmt nach Weyhs Darstellung (sofern vom Programmierer im Programm verwendet) aus der TITLE-Anweisung die Überschrift (Funktion) des Programms sowie beliebige Kommentare, die im Programm besonders gekennzeichnet wurden. Erfahrungsgemäß kann davon ausgegangen werden, meint Weyh, daß ein Programmierer eher bereit ist, Kommentare in ein Programm aufzunehmen oder bei Änderungen zu verändern, als eine separate Dokumentation fortzuschreiben. Durch Übernahme derartiger Kommentare in eine automatische Dokumentation wird damit eine "verbale Dokumentation" in aktuellster Form unterstützt, formuliert der Freiburger.
XD034 wird seit einem halben Jahr von allen Programmierern bei Kühn & Weyh eingesetzt, die /34 Installationen durchführen. Dadurch konnte bei allen Programmierarbeiten eine erhebliche Effizienzsteigerung erreicht werden, behauptet Weyh, und weiter: Es wurde festgestellt daß die so erstellten Dokumentationen den Anwenderanforderungen gerecht werden.
Informationen: Kühn & Weyh EDV-Beratung GmbH, Eisenbahnstr. 43, 7800 Freiburg, Tel.: 07 61/3 69 94.