Kapitel 10: Dokumentation

Größe: px

Ab Seite anzeigen:

Download "Kapitel 10: Dokumentation"

Benedict Kranz
vor 8 Jahren
Abrufe

1 Kapitel 10: Dokumentation Inhalt 10.1 Stellenwert der Dokumentation 10.2 Dokumentenlenkung 10.3 Dokumentation des Qualitätsmanagementsystems Schlüsselbegriffe Dokument, Dokumentenlenkung, Qualitätshandbuch Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-1

3 Dokumentation des Qualitätsmanagementsystems Schlüsselbegriffe

2 10.1 Stellenwert der Dokumentation Software ist kein materielles Produkt. Alle Entwicklungstätigkeiten manifestieren sich nur in Form von Dokumenten (auch der Programmcode ist ein Dokument). Den Dokumenten kommt daher im Software Engineering eine besondere Bedeutung zu. Dokumentationsarten Produktdokumentation dokumentiert das Produkt und seine Benutzung Projektdokumentation dokumentiert Planung und Verlauf von Software- Projekten Qualitätsdokumentation dokumentiert das Qualitätsmanagementsystem. Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-2

Den Dokumenten kommt daher im Software Engineering eine besondere Bedeutung zu.

3 Aufgaben der Dokumentation Wissenssicherung: Die Information aus den Köpfen holen Kommunikation: Reden miteinander genügt nicht (auch im Kleinprojekt!) Sichtbarmachen des Projektfortschritts: Dokumente sind die greifbaren Resultate des Entwicklungsprozesses Festlegen von Arbeitsweisen und Verfahren Das Was und Wie des Qualitätsmanagements Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-3

) Sichtbarmachen des Projektfortschritts: Dokumente sind die greifbaren Resultate des

4 Wirtschaftlichkeit der Dokumentation Die Erstellung der Dokumente kostet Geld Die Erstellung von Dokumenten vermeidet Fehler und hilft beim rechtzeitigen Finden von Fehlern: Dokumentation senkt die Fehlerkosten Gut dokumentierte Software ist einfacher zu pflegen: Dokumentation senkt die Wartungskosten Dokumentation ist kein Selbstzweck: nur soviel wie nötig dokumentieren, dies aber sorgfältig und konsequent Dokumentation ist wirtschaftlich (Bild 10.1) Nutzen mit ohne Dokumentation Zeit Entwicklung Betrieb / Wartung Kosten Bild 10.1: Wirtschaftlichkeit eines Systems mit und ohne Dokumentation (schematisch) Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-4

Selbstzweck: nur soviel wie nötig dokumentieren, dies aber sorgfältig und konsequent Dokumentation ist wirtschaftlich (Bild 10.

5 10.2 Dokumentenlenkung Die Norm ISO 9001 fordert für alle qualiätsrelevanten Dokumente Verfahren zur Lenkung der Dokumente, d.h. wie Dokumente genehmigt und herausgegeben werden wie Dokumente geändert, freigegeben und zurückgezogen werden welche Dokumente dieser Lenkung unterliegen. Genehmigung und Herausgabe wer prüft wer genehmigt Verteilung an alle Stellen, die ein Dokument brauchen Rückzug überholter Dokumente Änderung von Dokumenten Festlegung des Änderungsverfahrens (Antrag, Genehmigung, Durchführung, Freigabe) Sicherstellen des Konfigurationsmanagements Verfahren zur Aktualisierung/Neuherausgabe geänderter Dokumente Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-5

wie Dokumente genehmigt und herausgegeben werden wie Dokumente geändert, freigegeben und zurückgezogen werden welche Dokumente dieser Lenkung unterliegen.

6 10.3 Dokumentation des Qualitätsmanagementsystems Das Qualitätsmanagementsystem wird im Qualitätshandbuch dokumentiert (Bild 10.2). Band 1 des Handbuchs dokumentiert die Qualitätspolitik sowie die Qualitätsorganisation und gibt einen Überblick über die Qualitätsmaßnahmen. Es wird auf Verlangen an Kunden abgegeben. Band 2 des Handbuchs ist vertraulich. Es dokumentiert die genauen Verfahren und Maßnahmen und den Ablauf der Prozesse. Band 1: Überblick... Band 2: Verfahren... Arbeitsanweisung Prozessbeschreibung... Verfahrensanweisung Bild 10.2: Aufbau des Qualitätshandbuchs Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-6

Es wird auf Verlangen an Kunden abgegeben. Band 2 des Handbuchs ist vertraulich. Es dokumentiert die genauen Verfahren und Maßnahmen und den Ablauf der Prozesse.

7 Spezielle Fragen der Software-Entwicklung werden häufig in einem separaten Software-Entwicklungshandbuch geregelt (z.b. Codier-Richtlinien). Sind in einem Projekt besondere, vom Standard abweichende Qualitätsmaßnahmen erforderlich, so wird ein projektspezifischer Qualitätsplan erstellt. Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-7

Sind in einem Projekt besondere, vom Standard abweichende Qualitätsmaßnahmen

8 Aufgaben Aufgabe 10.1 Überlegen Sie sich mögliche Inhalte eines Software- Entwicklungshandbuchs. Skizzieren Sie ein entsprechendes Inhaltsverzeichnis. Zitierte Literatur EN ISO (1994). Qualitätsmanagement- und Qualitätssicherungsnormen - Teil 3: Leitfaden für die Anwendung von ISO 9001 auf die Entwicklung, Lieferung und Wartung von Software. EN ISO 9001(1994). Qualitätsmanagementsysteme : Modell zur Qualitätssicherung /QM- Darlegung in Design, Entwicklung, Produktion, Montage und Wartung. Software-Qualitätsmanagement Kapitel 10: Dokumentation Seite 10-8

Qualitätsmanagement- und Qualitätssicherungsnormen - Teil 3: Leitfaden für die Anwendung von ISO 9001 auf die Entwicklung, Lieferung und

Ähnliche Dokumente

Software Engineering. Dokumentation! Kapitel 21

Software Engineering. Dokumentation! Kapitel 21 Martin Glinz Thomas Fritz Software Engineering Kapitel 21 Dokumentation 2005-2013 Martin Glinz. Alle Rechte vorbehalten. Speicherung und Wiedergabe für den persönlichen, nicht kommerziellen Gebrauch gestattet;