Dokumentation in der Softwareentwicklung

Inhaltsverzeichnis

1 Einführung
1.1 Motivation
1.2 Ziel des Assignments
1.3 Aufbau des Assignments

2 Grundlagen
2.1 Begriff Dokumentation
2.2 Bedeutung der Dokumentation

3 Projektdokumentation
3.1 Dokumentation für das Projektteam
3.2 Dokumentation für das Management
3.3 Dokumentationsvermeidung

4 Produktdokumentation
4.1 Kategorien einer Produktdokumentation
4.2 Stakeholder-basierte Analyse

5 Zusammenfassung

Literaturverzeichnis

1 Einführung

In diesem Kapitel wird, im Anschluss an die Darlegung der Gründe für das Thema, der Aufbau des Assignments dargestellt.

1.1 Motivation

Die immer weiter fortschreitende Einflussnahme der Informationstechnologie (IT) in bestehende Wirtschaftssysteme und der damit verbundenen Globalisierung ist es von bedeutender Wichtigkeit schnell, präzise, genau und praxisnah zielgerichtete Software und Softwaresysteme zu entwickeln und zu verbessern. Die damit verbundene Durchführung von Projekten in der IT benötigt heutzutage die Steuerung durch ein Projektmanagement. Die Komplexität der IT-Projekte erfordert immer effizientere Projektmanagement-Methoden, um den Projektverlauf und die Termine gewährleisten zu können. Der schnelle Zugriff auf Projektdokumente ermöglicht dabei ein effizientes Projekt- und Wissensmanagement und trägt somit zur Qualitätssicherung bei.^[1]

1.2 Ziel des Assignments

Ziel dieses Assignments ist es, einen Überblick über die verschiedenen Dokumentationsarten in der jeweiligen Phase eines Softwareprojektes zu geben.

1.3 Aufbau des Assignments

Das Assignment ist in fünf Kapitel aufgeteilt. Im Anschluss an die Motivation und dem Ziel des Assignments werden im Kapitel 2 die Grundlagen und die Bedeutung der Dokumentation dargestellt. Im 3. Kapitel wird auf die Projektdokumentation und im 4. Kapitel auf die Produktdokumentation eingegangen. Im 5. und letzten Kapitel wird eine Zusammenfassung und Beurteilung des Themas in Bezug auf aktuelle und zukünftige Entwicklungen gegeben.

2 Grundlagen

Über den Umfang der Dokumentation gibt es viele Diskussionen. Der Kunde möchte oft sehr viel und umfangreich und der typische Entwickler möchte am liebsten nur Code erstellen.^[2] Das Agile Manifest^[3] beschreibt Werte um bessere Software zu entwickeln: „Funktionierende Software mehr als Dokumentation.“^[4] Diese Aussage kann von Verfechtern bzw. Gegnern der Dokumentation leicht missverstanden werden.

2.1 Begriff Dokumentation

Unter Dokumentation können die Methoden und die Tätigkeit des Sammelns, Erschließens, Ordnens, Aufbewahrens und gezielten Wiederfindens von Informationen zu spezifischen Fragen oder Aufgabestellungen verstanden werden. Das Ziel einer Dokumentation kann nach Friedrichsen wie folgt vom IEEE-Standard 1471-200 abgeleitet werden: ”Stakeholder haben Fragestellungen, die für sie wichtig sind und auf die sie gerne eine Antwort haben möchten bzw. haben müssen. Die Aufgabe der Dokumentation ist es, diese Fragen zu beantworten“.^[5] Sie kann somit anhand ihrer Zielgruppe in zwei wesentliche Bereiche unterteilt werden:

Projektdokumentation

- Dokumentation für das Projektteam
- Dokumentation für das Management

Produktdokumentation

- Dokumentation für die Anwendung der Software
- Dokumentation für die Installation und Administration

Aufgrund der verschiedenen Einsatzbereiche kann eine Dokumentation noch weiter unterteilt werden. Abbildung 1 gibt einen Überblick über eine erweiterte Gliederung. Aufgrund des Umfangs soll in dieser Arbeit nur auf die wichtigsten Bereiche, die Projekt- und Produktdokumentation eingegangen werden, welche im 2. bzw. 3. Kapitel näher betrachtet werden.

[...]

^[1] Vgl. Dan, 2007, S. 1

^[2] Vgl. Friedrichsen, 2011, S. 22

^[3] Das Agile Manifest enthält Werte mit dem Ziel, Softwareentwicklung flexibler, schlanker und auf den Nutzer ausgerichtet zu gestalten.

^[4] Vgl. Beck, Beedle, van Bennekum, Cockburn, et al., 2001

^[5] Friedrichsen, 2011, S. 23