Software Engineering. Dokumentation. Wintersemester 2005/06. Kapitel 21. Universität Zürich Institut für Informatik

Größe: px

Ab Seite anzeigen:

Download "Software Engineering. Dokumentation. Wintersemester 2005/06. Kapitel 21. Universität Zürich Institut für Informatik"

Arwed Falk
vor 8 Jahren
Abrufe

1 Martin Glinz Harald Gall Software Engineering Wintersemester 2005/06 Kapitel 21 Dokumentation Universität Zürich Institut für Informatik 2006 Martin Glinz. Alle Rechte vorbehalten. Speicherung und Wiedergabe sind für den persönlichen, nicht kommerziellen Gebrauch gestattet, wobei bei auszugsweiser Verwendung Quelle und Copyright zu nennen sind. Die Verwendung für Unterrichtszwecke oder für kommerziellen Gebrauch ist nur mit vorheriger schriftlicher Genehmigung des Autors gestattet.

2 21.1 Grundlagen 21.2 Produktdokumentation 21.3 Projektdokumentation 21.4 Erstellung und Pflege von Dokumenten Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 2

3 Was & Warum Software ist kein materielles Produkt manifestiert sich nur in Wirkungen und in Dokumenten Dokumentation ist wichtig Dokumentationsarten: Produktdokumentation dokumentiert das Produkt und seine Benutzung Projektdokumentation dokumentiert die Entwicklung Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 3

4 Aufgaben der Dokumentation Wissenssicherung Die Information aus den Köpfen holen Kommunikation Reden miteinander genügt nicht Sichtbarmachen des Projektfortschritts Dokumente sind die greifbaren Resultate des Entwicklungsprozesses Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 4

5 Wirtschaftlichkeit von Dokumentation Nur soviel wie nötig Das Nötige aber sorgfältig und konsequent Nutzen mit ohne Dokumentation Zeit Entwicklung Betrieb/Wartung Kosten Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 5

6 Mini-Übung 21.1 (Aufgabe 10.1 im Skript) Nehmen Sie Stellung zu folgenden Aussagen: a) Ich dokumentiere nicht, weil wir in unserem kleinen Projekt alles auch so im Griff haben. b) Ich dokumentiere keine Anforderungen, weil diese sich im Projektverlauf ja ohnehin ändern. c) Ich dokumentiere meinen Entwurf, sobald sich beim Testen zeigt, dass der Entwurf jetzt stabil ist. Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 6

7 21.1 Grundlagen 21.2 Produktdokumentation 21.3 Projektdokumentation 21.4 Erstellung und Pflege von Dokumenten Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 7

8 Produktdokumentation 1 Die Produktdokumente dokumentieren......die Anforderungen an das System...das Konzept der Lösung...die Einzelheiten der Lösung (Entwürfe und Realisierungen)...die Montage der einzelnen Komponenten (Integration und Installation)...die Planung von Tests und der Abnahme...die Handhabung des Systems (Benutzerdokumentation) Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 8

9 Produktdokumentation 2 Anforderungsspezifikation Was von dem zu entwickelnden System verlangt wird Lösungskonzept Die Architektur der Lösung Gliederung der Lösung in Komponenten Kommunikation zwischen den Komponenten Ressourcenverteilung Detailentwurf und Code Lösungsdetails (Algorithmen und Datenstrukturen) Entwürfe sind entweder separat vom Programmcode dokumentiert oder in Form von Kommentaren im Programmcode integriert Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 9

10 Produktdokumentation 3 Testvorschriften Tests für die einzelnen Komponenten Tests für die Integrationsschritte Systemtest (nach letztem Integrationsschritt) Abnahmevorschrift Abnahme = formaler Abschluss einer Entwicklung Prüfung, ob das System die im Anforderungsdokument gestellten Anforderungen erfüllt Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 10

11 Produktdokumentation 4 Integrationsplan Wie die einzeln fertiggestellten Komponenten zu einem in einer Testumgebung lauffähigen Gesamtsystem integriert werden Installationsanleitung Wie ein auf der Zielhardware lauffähiges System konfiguriert und auf der Zielhardware installiert wird Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 11

12 Produktdokumentation 5 Benutzerhandbuch Die Bedienungsanleitung für das System Welche Funktionen das System bereitstellt Wie man es startet Wie man es bedient Hinweis: Eingebettete Systeme haben kein Benutzerhandbuch. Ihre Benutzung wird im übergeordneten System dokumentiert. Glossar Erklärt die verwendeten Begriffe und Abkürzungen Hilfreich für Entwickler und Benutzer Sollte in jedem größeren Entwicklungsprojekt (projektbegleitend) erstellt werden Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 12

13 21.1 Grundlagen 21.2 Produktdokumentation 21.3 Projektdokumentation 21.4 Erstellung und Pflege von Dokumenten Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 13

14 Projektdokumente Projektplan Dokumentiert den geplanten Projektablauf Stellt SOLL und IST gegenüber Qualitätsplan Projektspezifische Vorgaben für die Qualität Projektprotokoll Sammlung aller Schriftstücke und Berichte aus dem Projekt Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 14

15 21.1 Grundlagen 21.2 Produktdokumentation 21.3 Projektdokumentation 21.4 Erstellung und Pflege von Dokumenten Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 15

16 Dokumenterstellung Schritthaltend mit der Entwicklung Keine «Hinterher»-Dokumentation Eventuell Überarbeitung von Dokumenten bei Projektabschluss Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 16

17 Dokumentverwaltung Dokumente unterliegen der Konfigurationsverwaltung ( Kapitel 23 der Folien) Klassifikation Leichtes Finden durch geordnetes Ablegen Freigabewesen Nur Freigegebenes gilt Änderungswesen Nur Aktuelles ist hilfreich Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 17

18 Literatur Im Skript [M. Glinz (2005). Software Engineering. Vorlesungsskript, Universität Zürich] lesen Sie Kapitel 10. Im Begleittext zur Vorlesung [S.L. Pfleeger, J. Atlee (2006). Software Engineering: Theory and Practice, 3rd edition. Upper Saddle River, N.J.: Pearson Education International] lesen Sie die Unterkapitel 4.8, 7.3, 9.8 und Software Engineering Kapitel 21: Dokumentation 2006 Martin Glinz 18

Ä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;