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.

Dokumentationsarten und -prinzipien

Dokumentation dient einerseits der Kommunikation aller an der Entwicklung beteiligten Gruppen und andererseits der Projektfortschrittskontrolle. Ebenso unterstützt eine aktuelle Dokumentation die Kalkulation der Projekt- und Produktkosten sowie eine bessere Planung zukünftiger Projekte.

Pomberger unterscheidet drei wesentliche Lesergruppen, auf die entsprechende Dokumentationsarten abzustimmen sind [Pomb96]:

a) Die Anwender/Interessenten

Für sie ist die Benutzerdokumentation von Bedeutung. Diese soll ausreichende Information für diejenigen bieten, die sich über das Produkt informieren wollen. Der Systemanwender soll durch sie eine Unterstützung bei der sicheren und funktionsgerechten Handhabung erhalten und im Zweifelsfall die für ihn nötigen Informationen rasch, anschaulich und umfassend erhalten.

b) Die Entwickler/Pfleger

Für sie ist die System- und die Wartungsdokumentation von Bedeutung. Die Systemdokumentation enthält all jene Informationen, die benötigt werden, um das System vom Aufbau her kennenzulernen und den aktuellen Zustand beurteilen zu können. Auf der Basis dieser Informationen können Änderungen und Erweiterungen durchgeführt werden. Sie soll einen ausreichenden Einblick in den bereits durchgeführten Entwicklungsprozess bieten und somit alle wesentlichen Phasenergebnisse in knapper und übersichtlicher Weise darstellen. Die Wartungsdokumentation enthält bei guter Organisation nur mehr jene systembeschreibenden Informationen, die die aktuelle Version des Systems ausreichend beschreiben.

c) Die Manager

Für sie ist die Projektdokumentation von Bedeutung. Diese enthält Informationen aus organisatorischer, kalkulatorischer und führungspolitischer Sicht. Sie umfasst im Wesentlichen Projekt- und Organisationspläne sowie Berichte, die Auskunft über Personal- und sonstigen Ressourceneinsatz, Zieldefinition, Zielerreichung und Projektvorkommnisse geben. Nach Projektabschluss dient diese Dokumentation zur statistischen Auswertung und soll helfen, nachfolgende Projekte und deren Umgebung besser zu planen.

Wesentlich für eine solche zielgruppengerechte Dokumentation ist, dass sie vollständig und auf die Interessen der jeweiligen Gruppe ausgerichtet ist. Für eine qualitative Bewertung der Dokumentation verweisen wir auf den Abschnitt Anforderungen an die Dokumentation und deren Erstellung aus der Sicht der Qualitätsgestaltung.

Als Dokumentationsprinzipien empfehlen wir:

  • Inhaltliche Güte

    Damit meinen wir die Breite und die Tiefe, mit der der jeweilige Textinhalt behandelt wird. Beide Aspekte müssen auf die jeweilige Zielgruppe abgestimmt sein. Die einzelnen Textabschnitte sollen vom Detaillierungsgrad (von der Tiefe) her ungefähr gleich behandelt werden. Unter Breite verstehen wir den inhaltlichen Vollständigkeitsgrad, mit dem ein Thema behandelt wird. Ein Indikator dafür ist, in welchem Ausmaß Ausnahme- und Sonderfälle abgehandelt werden. Im Text soll keine unnötige Redundanz vorhanden und die Konsistenz des behandelten Textinhalts gewährleistet sein.

  • Organisationsgüte

    Die Form und die Reihenfolge, in der der Inhalt behandelt wird, bestimmen die Organisationsgüte. Der Leser sollte immer wissen, wo er sich im Dokument gerade befindet, von wo er ausgegangen ist und welches Leseziel er erreichen kann. Dabei helfen ihm eine konsequente Nummerierung und aussagekräftige Überschriften. Der Text soll in logisch in sich abgeschlossene Abschnitte gegliedert werden. Eine ausgewogene, gut gegliederte Struktur hilft dem Leser, nicht von einer Fülle von Detailinformationen erschlagen zu werden. Einleitungen und Zusammenfassungen sind nützliche Hilfsmittel, diese Struktur zu verwirklichen. Sie fördern das Einprägen von Information in das Langzeitgedächtnis des Lesers.

  • Formatgüte

    Der Inhalt des Dokuments wird durch den Gebrauch geeigneter Sprachmittel (Ausdrucksweise) und durch Illustrationen leichter verstehbar. Ein einfaches Vokabular bzw. die Erklärung von Fachwörtern in einem Glossar, zusammen mit kurzen und direkten Sätzen in aktiver Form, erhöhen wesentlich die Verständlichkeit des Textes. Durch Illustrationen, z.B. Diagramme, wird das nichtverbale Verstehen angesprochen. Sie sind dann am wirkungsvollsten, wenn sie nahe bei der bezugnehmenden Textstelle stehen.


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