Dokumentationsdschungel mit methodischen Verfahren roden

19.02.1982

Nur relativ wenige Anwender scheinen den Stellenwert der DV-Dokumentation richtig zu erkennen und konsequent entsprechende Methoden einzusetzen. Häufig werden in der Dokumentationspraxis Informationen nur mündlich weitergegeben. Ansonsten besteht Dokumentation aus Flickwerk - nicht selten manuell "zusammengeschustert". So werden Teile, die zur Erstellung der Gesamtdokumentation nötig sind, oft noch kopiert, ausgeschnitten und aufgeklebt. Die derzeit auf dem Markt angebotenen Werkzeuge und Verfahren können wegen hoher Anschaffungskosten sowie des immensen Anpassungsaufwandes an die bereits vorhandenen firmenspezifischen Werkzeuge häufig nicht genügend genutzt worden. Dabei kann nur, langfristig ausgelegte Planung helfen. Resümiert DV-Berater Alexander Cramer: "Es ist höchste Zeit, die Dokumentationsschnittstellen dem technologischen Niveau der DV-Anlagen anzupassen."

Alexander Cramer

DV-Beratung, Organisation und Systementwicklung, Köln

Bei der Suche nach Lösungen für ein erkanntes und formuliertes Problem erweist es sich zuweilen als sinnvoll, sich auf die hinter bekannten

Schlagworten stehenden Begriffsinhalte zu besinnen. Dokumentation heißt nichts anderes als Sammlung, Ordnung nach bestimmten Kriterien und Nutzbarmachung von Dokumenten jeder Art, in diesem Fall von Programmen und deren organisatorischer und systemtechnischer Umgebung. Bereits an dieser Stelle zeigt sich deutlich das Dilemma: Programme sind deutlich das Dilemma für jeden lesbare und sichtbare Dokumente, sondern "unsichtbare Originale", die nur mittelbar durch Datenflußpläne, Programmablaufdiagramme, Source-Listings und Ergänzungslisten in ihrer Struktur und ausführliche Testein- und -ausgabebeschreibung in ihrer Wirkungsweise erkennbar und nachvollziehbar gemacht werden.

Obwohl der Einsatz von Computern insbesondere auf der Seite der Spezialisten, die diese Maschinen programmieren, ein Höchstmaß an Präzision und systematischer Arbeitsweise als selbstverständlich erscheinen läßt, erinnert die Dokumentationspraxis an die Art der mündlichen Weitergabe von Informationen unserer Vorfahren, bei der jeder etwas ergänzte oder vergaß.

Bedenkt man, daß heute viele Unternehmen in wesentlichen betrieblichen Bereichen ohne Alternativen auf die richtigen und termingerechten Arbeiten der EDV-Abteilung angewiesen sind, erscheint es fast unvorstellbar, daß trotzdem nur relativ wenige Anwender und, Benutzer den Stellenwert einer Dokumentation richtig erkennen und , konsequent entsprechende Methoden einsetzen. Dabei ist es zunächst wichtig, eine einheitliche Methode kontinuierlich anzuwenden. Ob manuell oder computerunterstützte Verfahren eingesetzt werden, hängt letztlich von Kostenaspekten und quantitativen Erfordernissen ab.

Ebenso wie Dokumentation in allen anderen Bereichen überwiegend dazu dient, in Ausnahmefällen Vergangenheitsdaten und -vorgänge schnell und richtig verfügbar zu haben, ermöglicht eine durchgängige Dokumentation in allen DV-Funktionsbereichen eine einheitliche und verständliche Kommunikationsebene.

Aus der Vielzahl der existierenden Methoden und Tools kann sicher keine grundsätzliche Empfehlung ohne Berücksichtigung der individuellen Umstände gegeben werden. Einige allgemein gültige Anforderungen können jedoch bei der Beurteilung von Dokumentationswerkzeugen wirksam Hilfestellung geben

- Art, Form und Umfang des Outputs;

- Revisionsfähigkeit der Ausdrucke;

- Anschaulichkeit und Übersichtlichkeit des Outputs;

- Schulungsaufwand für die Einführung;

- Preis-/Leistungsverhältnis;

- erforderliche Maschinenlaufzeit und Plattenkapazität;

- Einsatzmöglichkeit in der Analyse- und Konzeptionsphase;

- Möglichkeit des Programmänderungsdienstes über Bildschirm;

- ausreichende Verwendungsnachweise und automatische Pflege;

- Zugriffsmöglichkeit über Bildschirm auf gespeicherte Infos;

- Dateiverwaltung- und Auswertung.

Computerunterstützte Methoden weisen wesentliche Vorteile durch die Standardisierung der Ein- und Ausgabe auf. Außerdem führt jede Änderung, automatisch zu einem Update der Dokumentationsdaten. Personenunabhängigkeit und Transparenz werden kurzfristig erreicht, mittel- und langfristig sogar die von allen gewünschte wesentliche Verringerung des Aufwandes für Änderungen und die Reduzierung der damit verbundenen Fehlerquote.

Es ist höchste Zeit, die Dokumentationsschnittstelle dem

technologischen Niveau der DV-Anlagen anzupassen.

Dr. Peter Schnupp

Interface Gesellschaft für anwenderorientierte Kommunikationssysteme mbH, München

Wie jeder Dschungel ist auch der Dokumentationsdschungel gefährlich. Besondere Gefahr droht, wenn er ein Wirrwarr völlig unterschiedlicher Informationen ist. Wer in diesem Dschungel erst einmal drinnen ist, dem helfen zum Herauskommen nur noch Glück und die Machete. Besser man vermeidet ihn von Anfang an und bemüht sich um die Anpflanzung einer ordentlichen Plantage.

Wie steht es etwa mit der Nützlichkeit jener oft besonders undurchdringlichen Klasse von Dokumentationen, die mit vielen, vielen Blättern "Spezifikation" das zukünftige Softwareprodukt beschreiben sollen? Wobei derzeit zudem noch viele (grüne?) Software-Engineering-Technologen predigen, man müsse diese Spezifikation auch tüchtig wuchern lassen - sprich: ein Programm, bevor man es realisiert, bis in jedes Detail spezifizieren, möglichst sogar noch mehrmals hintereinander, in verschiedenen "Spezifikationsphasen".

Das Ergebnis ist dann wieder ein neues Stück Dokumentationsdschungel, bevor das dokumentierte Programm überhaupt existiert.

Zuweilen traut sich noch nicht einmal der Programmieren in ihn hinein, der das Spezifizierte programmieren soll. Er ginge ja doch nur darin verloren, und deshalb erfindet er vernünftigerweise seine Vorgaben lieber ganz neu.

Der Spezifikationsdschungel wird so unwirtlich, weil die gleichen Software-Engineering-Technologen, die seine Anpflanzung propagieren, sich meist keinen Deut darum scheren, Nutzpflanzen hierfür zu züchten - nämlich syntaktisch und semantisch eindeutige, kompakte und leicht verständliche Spezifikationssprachen. Deshalb muß der arme Praktiker derzeit seine Spezifikationen in Deutsch abfassen: eine Sprache, die sich vorzüglich zum Schreiben von Lyrik, Romanen und Dramen eignet, aber eben nicht für Spezifikationen eines Programmdokuments. Die entarten in ihr leicht zu den überdimensionalen Schulaufsätzen, die wir alle zu fürchten gelernt haben.

Daß es auch anders geht, zeigen neuere, formale Spezifikationssprachen. Leider sind sie jedoch, wie etwa IF ("Interface Formalization") oder Spezi, noch in der Piloterprobung, und die nötige Computerunterstützung wird erst entwickelt. Bis genügend von ihnen gekeimt und Wurzeln gefaßt haben, werden deshalb noch ein paar neue Dschungel spezifiziert werden. Und wachsen zur Freude der Abenteurer unter uns.

Dr. Karl-R. Moll Rolf Schmitz

Bayerische Hypotheken- und Wechsel-Bank AG, München

Unter dem Dokumentationsdschungel bei der Anwendungsentwicklung verstehen wir folgende Situation:

Erstellung und Verwaltung der Gesamtdokumentation (Systemdokumentation, Benutzerdokumentation, RZ-Dokumentation etc.) eines Softwareproduktes durch überwiegend manuelles Zusammenfügen (kopieren, schneiden, kleben) von überwiegend manuell (Schreibmaschine, Formblätter) sowie teils maschinell (mit den Verschiedensten "Werkzeugen" im weitesten Sinn) erstellten Textbausteinen ohne Verwendung eines Verfahrenshandbuchest welches die Struktur sowie die Vorgehensweise bei der Erstellung der Dokumente normiert. Unter den Werkzeugen verstehen wir dabei alle speziellen Werkzeuge zur Unterstützung der Anwendungsentwicklung, wie beispielsweise Entscheidungstabellengeneratoren, Data-Dictionary, Programmgeneratoren, Testgeneratoren, Spezifikationshilfen etc. und Dokumentenerstellungs- und Verwaltungssysteme sowie Anwendungsentwicklungsumgebungen.

Der dichteste Dschungel besteht dann, wenn bei der Projektabwicklung weder ein Verfahrenshandbuch noch ein Dokumenterstellungs- und Verwaltungssystem verwendet werden.

Die Einführung der zuletzt genannten Hilfsmittel ist ein erster, unbedingt erforderlicher Schritt zur Lichtung des Dschungels. Er kann aber vollständig geordnet werden, wenn die Durchführung der im Verfahrenshandbuch festgelegten Standards der Projectabwicklung durch eine Anwendungsentwicklungsumgebung unterstützt wird. In diese Umgebung müssen ein Dokumenterstellungs- und Verwaltungssystem sowie alle im Hause verwendeten speziellen Werkzeuge integriert, daß die Dokumenterstellung und Wartung keine der obengenannten manuellen Vorgänge nötig macht und die Struktur der Dokumente einheitlich wird.

Die folgenden Faktoren erschweren oder verhindern die Beseitigung des Dschungels:

1. Alle im Augenblick auf dem Markt befindlichen Anwendungsentwiklungsumgebungen integrieren nur einen jeweils kleinen Teil der notwendigen Werkzeuge.

2. Bei Firmen mit EDV-Tradition müssen in der Regel an der Entwicklungsumgebun sowie an den bereits vorhandenen Werkzeugen umfangreiche Anpassungen vorgenommen werden.

3. Es entstehen hohe Kosten für

a) Anschaffung der Werkzeuge (je nach Ausbau zirka 100 000 bis 800 000 Mark),

b) Anpassung,

c) Wartung,

d) Erstellung eines Verfahrenshandbuches,

e)Schulung der Mitarbeiter, wobei die unter b bis e genannten Kosten

sowohl von der stufe Ausbaustufe (a) als auch stark von der jeweiligen Firmenstruktur abhängen.

4. Die "Durststrecke" bis zum kostensparenden Einsatz ist groß. Langfristige Kostenersparnisse durch die Erhöhung der Softwareproducte sind nur schwer bewertbar.

Günter Lüth,

ADV/Orga F.A. Meyer GmbH, Wilhelmshaven

Wann immer sich der Org./DV-Bereich mit kreativen Aufgaben beschäftigen will, um endlich dem eigentlichen Ziel und Zweck der Datenverarbeitung gerecht zu werden, steht das Dokumentationsproblem im Wege. Nicht selten werden Schlüsselpersonen mit dieser "lästigen"

Tätigkeit gebunden. Kurzzeitiger Verzicht auf Dokumentation

führt zwangsläufig zu einem noch tieferen Absinken in den Dokumentationssumpf, aus dem es dann kaum noch ein Entrinnen gibt. Diese Situation ist um so erstaunlicher, da es auf dem Markt genügend Verfahren gibt, die Licht in das Dunkel bringen können.

Warum nutzt der Org./DV-Bereich die ihm angebotenen Methoden, Techniken und Werkzeuge so wenig? Einer der Gründe ist sicherlich die Verfahrensvielfalt. Wer soll da schon durchfinden?

Der Anbieter verspricht nicht selten die goldene Zukunft, und dem Org./DV-Bereich fehlt es in der Regel an geeigneten Maßstäben, um die getroffenen Aussagen und Leistungsangebote vor dem Hintergrund firmenspezifischer Anforderungen zu beurteilen.

Unser Haus hat die Erfahrung gemacht, daß nur eine langfistig ausgelegte Verfahrensgesamtplanung dem Anwender nachhaltig helfen kann. Ähnlich einer unbestreitbar notwendigen Rahmenplanung für die Informationsverarbeitung gibt der kurz-, mittel- und langfistig ausgelegte Verfahrensgesamtplan Auskunft darüber, welche Methoden, Techniken und Werkzeuge auf Dauer für den Anwender gut sind. vor dem Hintergrund eindeutiger Ziele und Rahmenbedingungen kann dann ergebnisorientiert mit der Organisation der Systemarbeit begonnen werden. Dabei ist das Lösen des Dokumentatiosproblems als Teil eines ganzheitlichen Lösungskonzeptes zu verstehen. Den relativ geringen Aufwand von wenigen Wochen für die Methodenverartwortlichen oder gar Systemprogrammierers verstanden werden. Es gilt vielmehr, alle betroffenen Systementwickeler in dem Entwicklungs- und Gesaltungsprozeß des Verfahrensgesamtplanes einzubeziehen. Diesbezüglich muß der Org./DV-Bereich die so oft gegenüber dem Fachbereich beschworene offene Kommunikations- und Arbeitsform auf sich selbst anwenden. Am Ende dieses Prozesses steht der Erfolg, denn gute Eigenorgamsation ist die Visitenkarte der Datenverarbeitung. Das schafft Vertrauen beim Fachbereich als Auftraggeber.