Dokumentation Vanessa Henn.

Präsentation zum Thema: "Dokumentation Vanessa Henn."—  Präsentation transkript:

1 Dokumentation Vanessa Henn

2 Gliederung Allgemeines Technische Dokumentation Anwenderdokumentation
Änderungsmanagement Praxis Quellen

3 Allgemeines „Dokumentation von Software hat das Ziel Entwicklern und Benutzern zu erklären, wie das Produkt funktioniert und wie es zu benutzen ist“  Soll Software für jeden nachvollziehbar machen

4 Allgemeines Erleichtert das Arbeiten mit der Software
Keine definierte Form oder Struktur

5 Technische Dokumentation
Oberbegriff für viele Dokumente Darstellung von technischen Sachverhalten und produktspezifischen Daten Alle Informationen zur Installation, Nutzung und Wartung der Software

6 Technische Dokumentation
Beispiele:  Bedienungsanleitung  Montageanleitung  Installationshandbücher  Technische Datenblätter

7 Anwenderdokumentation
Benutzerhandbuch für den Kunden Für problemlose Nutzung des Produktes

8 Änderungsmanagement Problem: Software ändert sich
Dokumentation muss angepasst werden Mit Hilfe von Werkzeugen wie Textverarbeitungsprogrammen Versionsdokumentationen

9 Praxis Leider nicht immer durchgeführt
Zu viel Arbeitsaufwand verbunden mit hohen Kosten Lösungen:  In Schätzung mit einbeziehen  Templates anlegen

10 Quellen (Stand: , 8:30) (Stand , 9:15) (Stand , 13:30) (Stand , 11:00) (Stand , 11:30) (Stand , 14:00)

11 Vielen Dank für eure Aufmerksamkeit!
Gibt es Fragen?

12 Beispiel Technische Dokumentation
Eigene Darstellung

13 Änderungen http://httpd.apache.org/docs/2.4/new_features_2_4.html
Eigene Darstellung

14 Beispiel Anwenderdokumentation
Eigene Darstellung