Inhaltsverzeichnis
1 Einführung 1
1.1 Motivation 1
1.2 Ziel des Assignments 1
1.3 Aufbau des Assignments 1
2 Grundlagen 2
2.1 Begriff Dokumentation 2
2.2 Bedeutung der Dokumentation 3
3 Projektdokumentation 5
3.1 Dokumentation für das Projektteam 5
3.2 Dokumentation für das Management 6
3.3 Dokumentationsvermeidung 6
4 Produktdokumentation 7
4.1 Kategorien einer Produktdokumentation 7
4.2 Stakeholder-basierte Analyse 8
5 Zusammenfassung 9
Literaturverzeichnis 10
Eidesstattliche Erklärung 11
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
Zielsetzung & Themen
Das primäre Ziel dieses Assignments ist es, einen strukturierten Überblick über die verschiedenen Arten der Dokumentation in den unterschiedlichen Phasen eines Softwareprojekts zu geben und deren Bedeutung für die Qualitätssicherung und das Projektmanagement zu beleuchten.
- Grundlagen und Definitionen von Dokumentation in der Softwareentwicklung
- Unterscheidung zwischen Projekt- und Produktdokumentation
- Herausforderungen in der Dokumentationserstellung für Projektteams und Management
- Methoden zur Dokumentationsvermeidung in agilen Umgebungen
- Stakeholder-basierte Analyse zur bedarfsgerechten Erstellung von Produktdokumentationen
Auszug aus dem Buch
3.1 Dokumentation für das Projektteam
Das Projektteam profitiert dahingehend von der Projektdokumentation, dass die beteiligten Mitarbeiter schnellen Zugriff auf alle bisherigen Arbeitsergebnisse haben. Dies erleichtert die Kommunikation untereinander und Mitarbeiter, die später in das Projekt einsteigen, können sich schneller und zielgerichteter einarbeiten. Zusätzlich unterstützt eine Projektdokumentation Zusammenhänge zu erkennen und Entscheidungen aus der Entwicklungsphase zu rekonstruieren.
Bei der Erstellung einer Projektdokumentation entstehen häufig Probleme, die es zu vermeiden gilt. Dies beinhaltet, dass die Dokumente entweder zu oberflächlich oder zu detailliert sind, nur die Sicht des Programmierers betrachtet wird, Begriffe unterschiedlich verwendet werden und die Dokumentation als lästig empfunden wird. Um diesen Problemen entgegenzuwirken empfiehlt es sich ein klar definiertes Vorgehensmodell zu nutzen, welches die einzelnen Dokumentenmodule exakt definiert. Mit Beginn der Betriebs- und Wartungsphase sollten daher alle Informationen bereits in der Produktdokumentation enthalten sein, sodass auch Personen, die bei der Entwicklung nicht beteiligt waren, das Produkt in der Wartungsphase betreiben, nutzen und warten können. Es ist heutzutage unwahrscheinlich, dass erstellte Projekte über den kompletten Produktlebenszyklus durchgängig von einem festen Team begleitet werden.
Zusammenfassung der Kapitel
1 Einführung: Dieses Kapitel motiviert die Notwendigkeit von Dokumentation in IT-Projekten und erläutert den Aufbau der Arbeit sowie deren Zielsetzung.
2 Grundlagen: Hier werden der Begriff Dokumentation sowie deren zentrale Bedeutung für die Qualitätssicherung und die Zusammenarbeit zwischen Stakeholdern definiert.
3 Projektdokumentation: Der Fokus liegt auf der internen Dokumentation für Projektteams und Management sowie auf Ansätzen zur effizienten Dokumentationsvermeidung.
4 Produktdokumentation: Dieses Kapitel behandelt die Kategorisierung von Dokumenten für das Endprodukt und stellt Methoden wie die stakeholder-basierte Analyse vor.
5 Zusammenfassung: Das abschließende Kapitel fasst die Erkenntnisse über die verschiedenen Dokumentationsarten zusammen und bewertet deren Rolle im Kontext agiler Prinzipien.
Schlüsselwörter
Softwareentwicklung, Projektdokumentation, Produktdokumentation, Qualitätssicherung, Agile Manifest, Projektmanagement, Stakeholder-Analyse, Dokumentationsvermeidung, Lastenheft, Pflichtenheft, Benutzerhandbuch, Wissensmanagement, Softwareprojekte, IT-Infrastruktur, Anforderungsanalyse
Häufig gestellte Fragen
Worum geht es in dieser Arbeit grundsätzlich?
Die Arbeit befasst sich mit der Bedeutung und den verschiedenen Ausprägungen der Dokumentation innerhalb von IT-Softwareprojekten.
Was sind die zentralen Themenfelder?
Die zentralen Themen sind die Abgrenzung zwischen Projekt- und Produktdokumentation sowie Strategien für eine effiziente und zielgruppenorientierte Erstellung dieser Unterlagen.
Was ist das primäre Ziel der Untersuchung?
Ziel ist es, einen Überblick über die unterschiedlichen Dokumentationsarten in den jeweiligen Phasen eines Softwareprojekts zu verschaffen.
Welche wissenschaftliche Methode wird verwendet?
Die Arbeit nutzt eine Literaturanalyse, um den Stand der Technik und verschiedene Ansätze zur Dokumentationsoptimierung zusammenzuführen.
Was wird im Hauptteil behandelt?
Der Hauptteil analysiert spezifisch die Anforderungen an Projektdokumentationen für Teams und Management, das Konzept der Dokumentationsvermeidung sowie die Kategorisierung und Analyse von Produktdokumentationen.
Welche Schlüsselwörter charakterisieren die Arbeit?
Wichtige Begriffe sind unter anderem Softwareentwicklung, Projekt- und Produktdokumentation, Qualitätssicherung sowie die stakeholder-basierte Analyse.
Wie unterscheidet sich die Projektdokumentation von der Produktdokumentation?
Die Projektdokumentation dient dem internen Fortschritt und der Nachvollziehbarkeit des Entwicklungsprozesses, während die Produktdokumentation den Anwendern und Administratoren Informationen über das fertige Produkt bereitstellt.
Was besagt das Agile Manifest in Bezug auf Dokumentation?
Das Agile Manifest priorisiert funktionierende Software gegenüber einer umfassenden Dokumentation, ohne die Dokumentation jedoch vollständig zu negieren.
Was ist das Ziel der stakeholder-basierten Analyse?
Durch diese Methode sollen die spezifischen Informationsbedürfnisse der verschiedenen Nutzergruppen identifiziert und die Dokumentation passgenau auf diese Fragestellungen zugeschnitten werden.
Welche Probleme entstehen häufig bei der Projektdokumentation?
Häufige Probleme sind zu oberflächliche oder zu detaillierte Dokumente, inkonsistente Begriffsverwendung oder das Empfinden der Dokumentation als lästige, nicht wertschöpfende Aufgabe.
- Arbeit zitieren
- Stefan Wachholz (Autor:in), 2012, Dokumentation in der Softwareentwicklung, München, GRIN Verlag, https://www.grin.com/document/208401
