nach oben
Meine Merkliste
Ihre Merklisteneinträge speichern
Wenn Sie weitere Inhalte zu Ihrer Merkliste hinzufügen möchten, melden Sie sich bitte an. Wenn Sie noch kein Benutzerkonto haben, registrieren Sie sich bitte im Hanser Kundencenter.

» Sie haben schon ein Benutzerkonto? Melden Sie sich bitte hier an.
» Noch kein Benutzerkonto? Registrieren Sie sich bitte hier.
Ihre Merklisten
Wenn Sie Ihre Merklisten bei Ihrem nächsten Besuch wieder verwenden möchten, melden Sie sich bitte an oder registrieren Sie sich im Hanser Kundencenter.
» Sie haben schon ein Benutzerkonto? Melden Sie sich bitte hier an.
» Noch kein Benutzerkonto? Registrieren Sie sich bitte hier.

« Zurück

Ihre Vorteile im Überblick

  • Ein Login für alle Hanser Fachportale
  • Individuelle Startseite und damit schneller Zugriff auf bevorzugte Inhalte
  • Exklusiver Zugriff auf ausgewählte Inhalte
  • Persönliche Merklisten über alle Hanser Fachportale
  • Zentrale Verwaltung Ihrer persönlichen Daten und Newsletter-Abonnements

Jetzt registrieren
Merken Gemerkt
Software-Qualität - Dokumentation

Die Rolle der Dokumentation in Software-Projekten

Die gegenwärtige Praxis bei Software-Projekten ist dadurch gekennzeichnet, dass der größte Teil der Dokumentation (Projekt-, Entwicklungs-, System-, Benutzerdokumentation) nicht aktuell, unvollständig und oft schwer zu lesen und zu verstehen ist. Übergeordnete Konzepte und Strukturübersichten fehlen und sind deshalb nach einiger Zeit nicht mehr vollständig rekonstruierbar. Zusammen mit der hohen Personalfluktuation trägt dieser Zustand wesentlich zur allgemeinen Software-Krise, insbesondere zur Wartungskrise bei.

Förderungsmaßnahmen zur projektbegleitenden Dokumentation

Wir haben bereits in der Einleitung zu Abschnitt Dokumentationsarten und -prinzipien auf die Probleme und Schwierigkeiten durch mangelhafte Software-Dokumentation hingewiesen. Es stellt sich nun die Frage, was alles getan werden kann, um diese Dokumentationskrise zu bekämpfen. Nachfolgende Faktoren gelten als Schlüssel zur Eindämmung und Beseitigung der Dokumentationsprobleme:

  • Einstellung, Ziele und Ausbildung
  • Infrastruktur des Arbeitsplatzes
  • Dokumentenmuster (Templates)
  • Werkzeugunterstützung
  • Qualitätsmaßnahmen
  • Managementunterstützung
  • Akzeptanzstrategien

Einstellung, Ziele und Ausbildung

Grundsätzlich ist das Dokumentieren eine gleichwertige Aktivität neben dem Codieren, den Analyse-, Entwurfs- und Testaktivitäten. Der Zeitaufwand für das Erstellen und Nachführen der Dokumentation muss genauso eingeplant und als produktiv bewertet werden wie der Aufwand für andere Tätigkeiten. Der Termindruck darf nicht dazu führen, Dokumentationsprozesse zu vernachlässigen oder zu verhindern. Software-Produkte sind so lange unvollständig und nicht vertriebsreif, solange ihre Dokumentation unvollständig ist oder den Anforderungen nicht entspricht. In der Aus- und Fortbildung ist auch das Dokumentieren zu berücksichtigen.

Infrastruktur des Arbeitsplatzes

Am Arbeitsplatz des Entwicklers sind Geräte und Werkzeuge bereitzustellen, die die Dokumentationserstellung unterstützen. Die gerätetechnische Ausstattung muss sowohl auf die programmtechnischen als auch auf dokumentationstechnischen Anforderungen ausgerichtet sein.

Ganz wenige Entwicklersysteme sind von vornherein auf die Belange der Dokumentationsprozesse ausgerichtet. Das Korrigieren und Aktualisieren von Dokumenten wird erleichtert, wenn komfortable Möglichkeiten zur Textmanipulation am Arbeitsplatz vorhanden sind. Graphische Darstellungen sind durch Werkzeuge zu unterstützen, die in die Arbeitsumgebung des Programmierers integriert sind. Ebenso ist der papierlose Austausch von Dokumenten in Entwicklergruppen zu unterstützen. Wenn z.B. nur PCs zur Dokumentation verwendet werden, ist eine Vernetzung empfehlenswert.

Dokumentenmuster (Templates)

Eine hilfreiche und die Qualität fördernde Maßnahme ist die Bereitstellung von Dokumentenmustern ([ www.itq.ch ], [ www.processimpact.com/goodies.shtml ], [ www.projekthandbuch.de ]). Es handelt sich dabei um Inhaltsverzeichnisse für alle wichtigen Phasendokumente zusammen mit Erläuterungstexten, wie das Skelettdokument auszufüllen ist. Darin können Dokumentationsrichtlinien verpackt werden, die die Nummerierung oder Überschriftengliederung regeln.

Grundsätzlich sollten Dokumentationsrichtlinien nicht in Aktenschränken verstauben, sondern als aktuelle, im Direktzugriff befindliche Datei am Arbeitsplatzrechner des Entwicklers vorhanden sein. Textschablonen, die beispielsweise Leerformulare , Titelblätter, Seitenköpfe, Modulköpfe und Programmrahmen enthalten, steigern die Qualität und Produktivität der Arbeit des Entwicklers. Sie tragen auch dazu bei, das Aussehen der Dokumente zu standardisieren. Es ist von Zeit zu Zeit zu prüfen, ob diese Templates der aktuellen Situation entsprechen oder verbessert werden müssen.

Werkzeugunterstützung

Software-Werkzeuge können dazu eingesetzt werden, Projekt- und Produktdokumentationen zu entwickeln und zu pflegen. Ausreichende Werkzeugunterstützung hat eine Reihe von Vorteilen. Die Dokumentation ist

  • leichter zu modifizieren und zu aktualisieren,
  • leichter zu formatieren,
  • leichter papierlos zu übermitteln,
  • leichter mit Konfigurationsmanagement-Werkzeugen zu verwalten bzw.
  • es gibt Retrieval-Funktionen, die das Suchen von oder in Dokumenten wesentlich erleichtern.

Aus dem bisher Geschilderten lässt sich folgern, dass wir zur Unterstützung des Dokumentationsprozesses folgende Werkzeuge benötigen:

  • Textverarbeitungswerkzeuge,
  • Informationsgeneratoren,
  • Graphikwerkzeuge und
  • Browser.

Wesentlich ist, dass eine einfache und wirkungsvolle Integration dieser Werkzeuge in die rechnergestützte Arbeitsumgebung des Entwicklers erfolgt.

Qualitätsmaßnahmen

Jedes Dokument ist nach seiner Erstellung einem Prüfprozess zu unterwerfen, um die inhaltliche und die äußere, formale Qualität festzustellen, sofern dies nicht vom verwendeten Werkzeug selbst zumindest zum Teil erzwungen wird. Je nach Bedeutung des Dokuments können abgestufte Qualitätsmaßnahmen ausgewählt werden. Beginnen wir beim einfachen Autor-Kritiker-Zyklus. Sobald ein erstelltes Dokument fertig ist, übergibt es der Autor einem Kollegen zur kritischen Durchsicht. Das Dokument wird von diesem sorgfältig und genau gelesen. Der Kritiker sollte die fachliche Qualifikation für die inhaltliche Prüfung des Dokuments besitzen. Kritik, Mängel und Verbesserungsvorschläge sind schriftlich festzuhalten.

Reviews sind bereits umfangreichere Prüfmaßnahmen, wobei mehrere Prüfer und eine strukturierte Vorgehensweise zum Einsatz gelangen sollen. Bei Reviews werden sowohl inhaltliche als auch formelle textliche Aspekte geprüft. Die wesentlichen Dokumente, die durch Reviews geprüft werden, sind Anforderungsdefinition, Entwurfsspezifikationen, Testplan, Testfälle, Code und Benutzerhandbücher.

Es ist empfehlenswert, Benutzerhandbücher potenziellen Benutzern, die das System noch nicht kennen, zur kritischen Durchsicht zu übergeben.

Managementunterstützung und Akzeptanzstrategien

Alle bisher besprochenen Maßnahmen fruchten letztendlich nicht, wenn das Management nicht voll hinter ihnen steht. Wenn das Management Prioritäten setzt, die das Dokumentieren vernachlässigen, kann viel an Motivation und Überzeugungskraft zerstört werden.

Vonseiten des Managements ist ausreichend Zeit für

  • die Entwicklung und Einführung von Dokumentationsverfahren,
  • die notwendige Planung und Beschaffung der Infrastruktur bzw. der Werkzeuge und - Dokumenten-Reviews

bereitzustellen. Insbesondere in der Einführungsphase neuer Dokumentationsverfahren ist die Unterstützung durch das Management entscheidend.

Die Basis für eine Akzeptanzstrategie bilden eine ausreichende Informationsbereitstellung bzw. die Einbeziehung der Mitarbeiter in die Entscheidungsfindung. Die Vorteile der Neuerungen müssen überzeugend propagiert werden. Außerdem ist bei Bedarf ausreichende Hilfestellung durch kompetente Fachleute bereitzustellen. Die Mitarbeiter selbst müssen ausreichend viel Zeit für die Umstellung auf neue Dokumentationsverfahren und deren Schulung einplanen dürfen.

Zusammenfassend stellen wir fest, dass ein geeignetes Klima für die Einführung und Durchführung der gewählten Maßnahmen geschaffen werden muss. Der Umstellungsprozess ist langwierig und schwierig. Alternativen zu diesen Maßnahmen sind nicht in Sicht.


Inhaltsverzeichnis
DIN EN ISO 9001:2015

Zum ISO 9001:2015 Special

Prozesswelt

Serie zum Thema Prozesse, veröffentlicht von QM-Experten deutscher Unternehmen gemeinsam mit der N5 GmbH und der Fachzeitschrift QZ

Zur Prozesswelt