Dokumentation Vanessa Henn

Gliederung Allgemeines Technische Dokumentation Anwenderdokumentation Änderungsmanagement Praxis Quellen

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

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

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

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

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

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

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

Quellen https://www.qz-online.de/qualitaets-management/qm-basics/software-qualitaet/dokumentation/artikel/die-rolle-der-dokumentation-in-software-projekten-258004.html?_req_id=91547507140617:82632743EEC0ED6ADDAFC7EF9ACF2D390001CF62&survey_258004.current-step=1 (Stand: 15.01.2019, 8:30) https://instrktiv.com/de/was-ist-technische-dokumentation/ (Stand 15.01.2019, 9:15) https://www.caq.de/de/Software/Aenderungsmanagament (Stand 16.01.2019, 13:30) https://www.arakanga.de/arawiki/technische-dokumentation/anwenderdokumentation.html (Stand 13.01.2019, 11:00) http://www.infrasoft.at/downloads/Dokumentation_in_der_Softwareentwicklung.pdf (Stand 13.01.2019, 11:30) http://httpd.apache.org/docs/2.4/ (Stand 16.01.2019, 14:00)

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

Beispiel Technische Dokumentation http://httpd.apache.org/docs/2.4/ Eigene Darstellung

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

Beispiel Anwenderdokumentation http://saptraining.fh-wuerzburg.de/pages/downloads/doku/anwenderdokumentation.pdf Eigene Darstellung