Melden Sie sich hier an, um auf Kommentare und die Whitepaper-Datenbank zugreifen zu können.

Kein Log-In? Dann jetzt kostenlos registrieren.

Falls Sie Ihr Passwort vergessen haben, können Sie es hier per E-Mail anfordern.

Der Zugang zur Reseller Only!-Community ist registrierten Fachhändlern, Systemhäusern und Dienstleistern vorbehalten.

Registrieren Sie sich hier, um Zugang zu diesem Bereich zu beantragen. Die Freigabe Ihres Zugangs erfolgt nach Prüfung Ihrer Anmeldung durch die Redaktion.


18.06.1982

Dokumentation - eine lästige Angelegenheit?

Die Situation mangelhaft dokumentierter Software in der Praxis; das Unbehagen, Dokumentation schreiben zu müssen; das Problem, mit nicht dokumentierter Software arbeiten zu müssen; die Unmöglichkeit, nicht dokumentierte Software modifizieren, ändern oder anpassen zu müssen.

Die Erlernbarkeit maschinelle Dokumentationshilfsmittel ist

- sowohl für den Software-Entwickler und Programmierer

- als auch für Schreibkräfte und Hilfspersonal kein Problem.

Entwickler sind es heute sowieso gewohnt, am Terminal zu arbeiten, zum Beispiel mit Interaktiven Programmiersystemen und können dort auch ohne Schwierigkeiten ihre Dokumente erfassen und bearbeiten.

Schreibkräfte sind den Umgang mit der Schreibmaschine gewohnt und haben erfahrungsgemäß keine Schwierigkeiten, sich auf das Arbeiten am Terminal einzustellen. Die meist andere Tastatur mit zusätzlichen Funktionstasten wird ihnen nach kurzer Gewöhnungszeit vertraut.

Werden maschinell erstellte Dokumente langfristig, auch während des Einsatzes des Software-Systems, EDV-mäßig gespeichert, müssen

- Anwender

- Bediener und

- Softwarewartung im Auskunfts- und Informationsmodus auf die Dokumentation zugreifen und gegebenenfalls Änderungen einbringen.

Auch für diese Personengruppen dürften keine Schwierigkeiten in der Handhabung bestehen. Für Bediener und Softwarewartung sowieso nicht, für den Anwender deshalb nicht, weil er häufig selber auch Bediener ist und viele Software-Systeme ihm heute das Terminal als Arbeitsmittel an seinen Arbeitsplatz bringen.

Im Hinblick auf die organisatorischen Voraussetzungen, die geschaffen sein müssen, um Dokumentations-Werkzeuge einsetzen zu können, ist darauf zu achten, daß die Werkzeuge

- in den Entwicklungsprozeß

- in den Einsatzprozeß

- in den Wartungsprozeß eingepaßt werden.

Dabei sind

- Dialogarbeitsplätze/Datensichtstationen

- Ausgabegeräte wie Drukker, Mikrofilmausgabegeräte in ausreichender Anzahl zur Verfügung zu stellen. Für zwei höchstens drei Software-Entwickler sollte ein Terminals bereitstehen, wenn neben der Systementwicklungstätigkeit gleichzeitig dokumentiert wird.

Seitens des Rechenzentrums müssen für die Dokumentation ausreichend Betriebsmittel wie

- Speicherplatz

-CPU-Zeit

- Externspeicher

-Systemunterstützung

- Dateiverwaltungssystem

- Datenbanksystem

- Datenkommunikationssystem zur Verfügung stehen. Und das auch während Engpässen zu Testzeiten und während eines eventuellen Probebetriebs! Denn auch zu diesen Zeiten wird laufend dokumentiert.

Hier sind sicher erhebliche Vorleistungen zu erbringen, die eine maschinell gestützte Dokumentation nicht gerade "billig" machen. Aber hier gilt dasselbe wie für den Einsatz von Werkzeugen zur Unterstützung softwaretechnologischer Methoden: Wenn die Software-Dokumentation qualitativ gut und besser als bis sein soll, kostet das etwas!

Der Einsatz von Werkzeugen erfordert darüber hinaus

- Zeit für Einführung und Erlernung

- Aufwand für Wartung und gegebenenfalls Pflege der Werkzeuge.

Die Titelfrage "Dokumentation maschinell oder manuell?" kann nicht einheitlich und endgültig beantwortet werden. Da bisher kein alle Aufgaben der Software-Dokumentation unterstützendes Systems vorhanden ist, wird es in der Praxis immer eine Kombination von maschinell - manuell geben. Die zur Zeit vorhandenen Werkzeuge sollten in Ergänzung softwaretechnologischer Werkzeuge eingesetzt werden mit dem Ziel, schneller und sicherer qualitativ gute Software-Dokumentation zu erstellen.

Hierfür sind Vorleistungen und zum Teil erhebliche Investitionen zu erbringen.

Auch manuell kann qualitativ gute Software-Dokumentation erstellt werden, jedoch mit einem erheblichen Zeitaufwand und nur mit Mitarbeitern, die in der Software-Dokumentation Erfahrung haben, und das auch nur dann, wenn die Qualität der erstellten Dokumente kontinuierlich ausreichend kontrolliert wird.

Die Frage "maschinell - manuell" wird sich voraussichtlich ähnlich von selbst beantworten wie seinerzeit die Frage "lnteraktive Programmentwicklung ja oder nein?"

Es dürfte eine Frage der Zeit sein, daß sowohl Dokumentations-Standards als auch ausreichend Werkzeug zur Verfügung stehen. Darüber hinaus müßte es dann auch gelingen, Geräte für die Erfassung und Ausgabe von Dokumenten (in der Regel Terminal und Drukker) zu haben, die über einen ausreichenden Zeichenvorrat verfügen, um alle in der Textverarbeitung vorkommenden Zeichen darstellen zu können und um auch grafisch einwandfreie Diagramme, Abbildungen, Zeichnungen erstellen zu können. Denn daran kranken zur Zeit noch alle maschinellen Dokumentationshilfsmittel.

Erika Baumann ist freiberufliche DV-Beraterin in München