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.

02.07.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.

* Erika Baumann ist freiberufliche DV-Beraterin in München Letzter Teil

Zur Analyse und Aufzeichnung des Inhalts von Daten, Dateien und Datenträgern, aus denen Datenbeschreibungen erstellt werden können, gibt es bei den einzelnen Herstellern sogenannte Dienstprogramme oder Utilities, die Bestandteil des jeweiligen Betriebssystems sind. Sie können für die Nachdokumentation gute Unterstützung leisten.

Soll rückwirkend die Anwender-/Benutzerdokumentation ganz oder teilweise erstellt werden, kann zum Beispiel folgendermaßen vorgegangen werden;

- Aufzeichnen aller Bedienungsschritte für Normalabläufe, Sonderabläufe, Behebung von Fehlersituationen;

- Aufzeichnen aller Meldungen, Anzeigen, Dialogschritte;

- Führen eines Logbuchs im Sinne eines Bedienblattschreiberprotokolls, wie es von früheren Systemen her bekannt ist;

- Erstellen einer Hardcopy von Bedienungsbildschirmen;

- Zusammenstellen von Bedienkommandos in Kommandoprozeduren;

- Einsatz von Programmen die Produktivabläufe verfolgen und protokollieren, ähnlich wie Testverfolger, die zum Programmtest eingesetzt werden.

Ein methodisches Vorgehen eigens für die Nachdokumentation

von Softwaresystemen gibt es nicht. Prinzipiell ist nach den gleichen Methoden vorzugehen, die für die Erstdokumentation von Softwaresystemen zu empfehlen sind, und von denen in einer früheren Folge dieser Serie die Rede war.

Bei der Rückführung des Quellcodes in Beschreibungselemente und damit zu Bestandteilen einer Dokumentation können unterstützend eingesetzt werden

- Interaktive Programmiersysteme;

- Dateiaufbereiter oder Editoren, die über geeignete textbearbeitende Kommandos verfügen;

- maschinelle Strukturierhilfen wie Strukturgeneratoren.

Für die Nachdokumentation eines Softwaresystems werden auch bei Einsatz maschineller Unterstützung eine größere Anzahl geeigneter Mitarbeiter benötigt.

Grundsätzlich ist denkbar das in der Softwareentwicklungsabteilung, im Rechenzentrum oder beim Anwender vorhandene Personal mit der Nachdokumentation zu beauftragen, das ansonsten mit anderen Angaben betraut ist. Ist das nicht möglich, kann zum Beispiel für die einmalige Tätigkeit der Nachdokumentation unterschiedliches Personal alternativ oder als Team bereitgestellt werden

- Personal aus dem eigenen Haus, gegebenenfalls aus einer anderen Abteilung oder einem anderen Projekt;

- Hilfspersonal wie Studenten oder Büroaushilfen für die zahlreichen, manuellen Arbeiten;

- Dokumentationsfachleute aus der Softwareentwicklungsabteilung oder von externen Softwarehäusern (es gibt einschlägige Unternehmen, die sich ausschließlich mit Organisation und Methoden der Softwaredokumentation beschäftigen!).

Der Zeitpunkt, zu welchen mit der Nachdokumentation eines bestehenden Softwaresystems begonnen werden sollte, hängt wesentlich davon ab,

- aus welchen Gründen und

- mit welcher Zielsetzung die Nachdokumentation in Angriff genommen werden soll.

Als Zeitpunkte sind denkbar

- ein beliebiger Stichtag;

- ein Kalender- oder Geschäftsjahreswechsel, wenn das Softwaresystem solche Zeiteinheiten verarbeitungstechnisch berücksichtigt, zum Beispiel Buchhaltungssysteme;

- im Zusammenhang mit einer generellen Untersuchung des Softwaresystems, die zum Beispiel darüber befindet, ob das System überhaupt im Einsatz bleiben soll.

Es gibt keine Erfahrungswerte darüber, wie lange die Nachdokumentation für ein Softwaresystem dauert, zumindest können Einzelerfahrungen nicht zu Richtwerten erhoben werden. Wie im vorangegangenen beschrieben, ist Nachdokumentation von Ansatz und von der Methode her wesentlich schwieriger als eine Erstdokumentation, die parallel zur Systementwicklung erstellt wird. In der Vielzahl der Fälle (bei durchschnittlicher Anwendersoftware überwiegend im kommerziellen Bereich) kann gegebenenfalls davon ausgegangen werden, daß die Nachdokumentation zwei- bis dreimal solange dauert wie die Erstdokumentation.

Die Titelfrage "Nachdokumentation vorhandener Softwaresysteme - ist das möglich?" kann abschließend so beantwortet werden:

- Prinzipiell ist eine Nachdokumentation möglich;

- ein eigenes methodisches Vorgehen für diese Art der Dokumentation ist nicht vorhanden;

- maschinelle Unterstützung gibt es in Teilbereichen;

- da der Ansatz zur Nachdokumentation und eine geeignete Vorgehensweise nicht nur schwierig, sondern sehr stark individuell im Hinblick auf das Softwaresystem bestimmt sind, ist Nachdokumentation wesentlich schwieriger als Erstdokumentation, sie bedarf erfahrener Dokumentationsfachleute;

- im Hinblick auf die zeit-, personal- und kostenintensive Tätigkeit sollte Nachdokumentation (noch mehr als die Erstdokumentation) unter dem Gesichtspunkt der praktischen Verwendbarkeit erstellt werden.