Dokumentation ist in der Softwareentwicklung ein geläufiges Stichwort. Sie ist Be-standteil jeder Software. Zu den Aufgaben eines Programmierers gehört es Entwicklerdokumentation zu erstellen. Sie „ (...) dient der Aufzeichnung von Informationen über die Prozesse und Produkte der Entwicklung.“
Entwicklerdokumentation wird verschieden gehandhabt und bewertet. Einerseits wird sie in der Softwareentwicklung als absolut notwendig erachtet und sogar postuliert, je mehr in einem Softwareentwicklungsprojekt dokumentiert wird, desto „besser“ ist dies für ein Projekt. Diesem Verständnis liegen zum Beispiel Vorgehensmodelle, wie das CMM, das V-Modell oder auch die ISO 9000, zugrunde.
Andererseits wird Entwicklerdokumentation in den Hintergrund gestellt, als hinderlich für ein erfolgreiches Softwareprojekt angesehen und soweit wie möglich reduziert. In der Praxis kann häufig beobachtet werden, dass Entwicklerdokumentation, selbst bei erfolgreichen Softwareentwicklungen, als lästig angesehen und vernachlässigt oder teilweise weggelassen wird. Von Dokumentationsvorgaben wird häufig abgewichen und erstellte Entwicklerdokumentation wird als mangelhaft bewertet.
Entwicklerdokumentation hat sich jedoch für Beteiligte an einem Entwicklungsprojekt als hilfreiches Mittel zur Arbeitsunterstützung herausgestellt. Aus diesem Grund wird die Entwicklerdokumentation auch als ein „notwendiges Übel“ bezeichnet.
Es existieren verschiedene Ansätzen zur Softwareentwicklung, mit jeweils verschieden stark ausgeprägten Anweisungen und Gestaltungsvorgaben zur Erstellung von Entwicklerdokumentation. Daraus lässt sich schließen, dass verschiedene Aspekte bei der Bestimmung eines effizienten Grades der eingesetzten Entwicklerdokumentation von Bedeutung sind. Deshalb lassen sich unterschiedliche Gestaltungsalternativen in Bezug auf die Erstellung von Entwicklerdokumentation finden.
Die Softwarebranche ist ein stark umkämpfter Markt. Um Wettbewerbsvorteile erreichen zu können ist es wichtig, die Softwareentwicklung so effizient wie möglich zu gestalten und Software auf hohem qualitativem Niveau zu erstellen. Doch die eine „silber-ne Kugel“, welche die Softwarekosten zur Erstellung qualitativ guter Software reduziert, ist nicht in Sicht. Aus diesem Grund kann sich nur in kleinen Schritten einer effizienten Softwareentwicklung genähert werden.
Inhaltsverzeichnis
- 1 Einleitung
- 1.1 Problemstellung
- 1.2 Einordnung und Ziel der Arbeit
- 1.3 Vorgehensweise
- 1.4 Erläuterung verwendeter Begriffe
- 2 Entwicklerdokumentation
- 2.1 Gegenstände der Entwicklerdokumentation
- 2.2 Gründe für Entwicklerdokumentation
- 2.2.1 Wissenskonservierung
- 2.2.2 Wissenstransfer
- 2.2.3 Koordination
- 2.2.4 Kommunikation
- 2.2.5 Softwareerstellungs-Vertrag
- 2.2.6 Organisatorische Politik und Macht
- 2.2.7 Strukturierung der Implementierung
- 2.2.8 Durchdringung inhaltlicher Konzepte
- 2.2.9 Geforderte Qualitätsstandards
- 2.2.10 Dokumentationsvorgaben
- 2.3 Nachteile von Entwicklerdokumentation
- 2.3.1 Aktualität
- 2.3.2 Aktualisierungsaufwand
- 2.3.3 Verständlichkeit
- 2.3.4 Informationsfindung
- 2.3.5 Zusätzlicher Ressourcenbedarf
- 2.3.6 Motivationsproblem
- 3 Effizienzsteigerung des Einsatzes von Entwicklerdokumentation
- 3.1 Effizienz von Entwicklerdokumentation
- 3.2 Maßnahmen zur Effizienzsteigerung
- 3.2.1 Grundkonzepte und Qualitätsanforderungen
- 3.2.2 Quantitative Aspekte
- 3.2.3 Alternativen zu traditionellen Ansätzen der Dokumentation
- 3.3 Kritische Beleuchtung weiterer und genannter Vorschläge
- 3.3.1 Zeitpunkt von Dokumentation
- 3.3.2 Technische Hilfsmittel
- 3.3.3 Video- und Audioaufnahmen als Dokumentation
- 3.3.4 Kompletter Dokumentationsverzicht
- 3.3.5 Positive Aspekte von Redundanzen
- 3.3.6 Unnötigkeit richtiger und aktueller Dokumentation
- 3.3.7 Teamgröße und angemessene direkte Kommunikation
- 3.3.8 Öffentliche Präsentation und Prozessdokumentation
- 4 Einflussfaktoren auf Entwicklerdokumentation
- 4.1 Organisatorische Einflussfaktoren
Zielsetzung und Themenschwerpunkte
Die Arbeit untersucht die Effizienz von Entwicklerdokumentation in der Softwareentwicklung und präsentiert Maßnahmen zur Verbesserung. Ziel ist es, die Herausforderungen der Dokumentation zu analysieren und praktikable Lösungen aufzuzeigen, die den Erstellungsprozess effizienter gestalten.
- Herausforderungen der Entwicklerdokumentation (Aktualität, Verständlichkeit, Aufwand)
- Maßnahmen zur Effizienzsteigerung (dokumentationsbezogen, organisationsbezogen, technikbezogen)
- Alternativen zur traditionellen schriftlichen Dokumentation (Pair Programming, direkte Kommunikation etc.)
- Einflussfaktoren auf die Effizienz (Anforderungsdynamik, Sicherheitsanforderungen)
- Optimierung des Umfangs und der Gegenstände der Dokumentation
Zusammenfassung der Kapitel
1 Einleitung: Dieses Kapitel führt in die Thematik der Entwicklerdokumentation ein, beschreibt die Problemstellung – die Dokumentation als ineffizientes Übel – und formuliert das Ziel der Arbeit: die Effizienzsteigerung der Entwicklerdokumentation. Es wird die Vorgehensweise erläutert und verwendete Begriffe definiert, um eine einheitliche Basis für die weitere Analyse zu schaffen. Die Einleitung legt den Grundstein für die nachfolgenden Kapitel, indem sie den Fokus auf die Problematik und das Ziel der Arbeit lenkt.
2 Entwicklerdokumentation: Dieses Kapitel befasst sich umfassend mit dem Thema Entwicklerdokumentation. Es werden zunächst die verschiedenen Gegenstände der Dokumentation, wie Anforderungen, Architekturen und Quellcode, aufgeführt. Anschließend werden die Gründe für die Erstellung von Entwicklerdokumentation detailliert dargestellt, von der Wissenskonservierung und dem Wissenstransfer bis hin zur Erfüllung von Vertragsbedingungen und organisatorischen Vorgaben. Im Anschluss werden die Nachteile ausführlich diskutiert, beispielsweise der hohe Aktualisierungsaufwand, mangelnde Verständlichkeit und die Schwierigkeiten bei der Informationsbeschaffung.
3 Effizienzsteigerung des Einsatzes von Entwicklerdokumentation: Dieses Kapitel steht im Zentrum der Arbeit und präsentiert verschiedene Konzepte und Maßnahmen zur Effizienzsteigerung. Es werden sowohl grundlegende Konzepte und Qualitätsanforderungen als auch quantitative Aspekte der Dokumentation betrachtet. Ein Schwerpunkt liegt auf alternativen Ansätzen, die traditionelle schriftliche Dokumentation ergänzen oder ersetzen sollen. Darüber hinaus werden verschiedene Vorschläge kritisch beleuchtet, darunter der Zeitpunkt der Dokumentation, der Einsatz technischer Hilfsmittel, der Verzicht auf Dokumentation und die Rolle der Teamgröße und Kommunikation.
4 Einflussfaktoren auf Entwicklerdokumentation: Das Kapitel analysiert die Faktoren, welche die Effizienz der Entwicklerdokumentation beeinflussen. Es konzentriert sich auf organisatorische Faktoren und wie diese die Erstellung, den Nutzen und die Effektivität der Dokumentation prägen. Hier wird der Kontext der Softwareentwicklung und des Anwendungskontexts in den Fokus gerückt und deren Auswirkungen auf die getroffenen Maßnahmen zur Effizienzsteigerung untersucht.
Schlüsselwörter
Entwicklerdokumentation, Effizienz, Softwareentwicklung, Wissensmanagement, Kommunikation, Alternativen zur Dokumentation, Anforderungsdynamik, Sicherheitsanforderungen, Teamgröße, Qualitätssicherung.
Häufig gestellte Fragen zur Entwicklerdokumentation
Was ist der Inhalt dieser Arbeit zur Entwicklerdokumentation?
Diese Arbeit untersucht die Effizienz von Entwicklerdokumentation in der Softwareentwicklung und präsentiert Maßnahmen zur Verbesserung. Sie analysiert die Herausforderungen der Dokumentation und zeigt praktikable Lösungen auf, um den Erstellungsprozess effizienter zu gestalten. Der Fokus liegt auf der Steigerung der Effizienz durch verschiedene Maßnahmen und die kritische Betrachtung von Alternativen zur traditionellen schriftlichen Dokumentation.
Welche Themen werden in der Arbeit behandelt?
Die Arbeit behandelt folgende Themenschwerpunkte: Herausforderungen der Entwicklerdokumentation (Aktualität, Verständlichkeit, Aufwand), Maßnahmen zur Effizienzsteigerung (dokumentationsbezogen, organisationsbezogen, technikbezogen), Alternativen zur traditionellen schriftlichen Dokumentation (Pair Programming, direkte Kommunikation etc.), Einflussfaktoren auf die Effizienz (Anforderungsdynamik, Sicherheitsanforderungen) und die Optimierung des Umfangs und der Gegenstände der Dokumentation.
Welche Kapitel umfasst die Arbeit?
Die Arbeit gliedert sich in vier Kapitel: Kapitel 1 (Einleitung) führt in die Thematik ein und definiert die Problemstellung und das Ziel der Arbeit. Kapitel 2 (Entwicklerdokumentation) behandelt die Gegenstände, Gründe und Nachteile der Entwicklerdokumentation. Kapitel 3 (Effizienzsteigerung des Einsatzes von Entwicklerdokumentation) präsentiert Maßnahmen zur Effizienzsteigerung und beleuchtet kritisch verschiedene Vorschläge. Kapitel 4 (Einflussfaktoren auf Entwicklerdokumentation) analysiert organisatorische Einflussfaktoren auf die Effizienz der Dokumentation.
Welche Herausforderungen der Entwicklerdokumentation werden angesprochen?
Die Arbeit adressiert Herausforderungen wie die Aktualität, die Verständlichkeit und den hohen Aufwand der Entwicklerdokumentation. Es wird untersucht, wie diese Herausforderungen die Effizienz der Softwareentwicklung beeinträchtigen.
Welche Maßnahmen zur Effizienzsteigerung werden vorgeschlagen?
Die Arbeit schlägt verschiedene Maßnahmen zur Effizienzsteigerung vor, darunter dokumentationsbezogene Maßnahmen (Verbesserung der Struktur und des Inhalts), organisationsbezogene Maßnahmen (Optimierung der Prozesse) und technikbezogene Maßnahmen (Einsatz von Werkzeugen). Es werden auch alternative Ansätze zur traditionellen schriftlichen Dokumentation, wie Pair Programming und direkte Kommunikation, betrachtet.
Welche Alternativen zur traditionellen schriftlichen Dokumentation werden diskutiert?
Die Arbeit diskutiert Alternativen wie Pair Programming und direkte Kommunikation als Ergänzung oder Ersatz für traditionelle schriftliche Dokumentation. Der Fokus liegt dabei auf dem Abwägen von Vor- und Nachteilen dieser Ansätze im Kontext der Effizienzsteigerung.
Welche Einflussfaktoren auf die Effizienz der Entwicklerdokumentation werden betrachtet?
Die Arbeit betrachtet organisatorische Einflussfaktoren wie die Anforderungsdynamik und Sicherheitsanforderungen, die einen erheblichen Einfluss auf den Aufwand und die Effektivität der Dokumentation haben.
Wie wird die Effizienz der Entwicklerdokumentation definiert und gemessen?
Die Arbeit legt den Fokus auf die Verbesserung der Effizienz, ohne explizit eine Messmethode zu definieren. Die Effizienz wird eher implizit durch die Reduktion des Aufwands, die Verbesserung der Verständlichkeit und die Steigerung der Aktualität der Dokumentation beurteilt.
Welche Schlussfolgerungen zieht die Arbeit?
Die Arbeit kommt zu dem Schluss, dass die Effizienz der Entwicklerdokumentation durch gezielte Maßnahmen, die sowohl die Dokumentation selbst als auch die organisatorischen und technischen Rahmenbedingungen betreffen, deutlich verbessert werden kann. Es werden keine endgültigen Lösungen präsentiert, sondern vielmehr Ansatzpunkte für eine verbesserte Praxis in der Softwareentwicklung aufgezeigt.
Welche Schlüsselwörter beschreiben den Inhalt der Arbeit?
Schlüsselwörter sind: Entwicklerdokumentation, Effizienz, Softwareentwicklung, Wissensmanagement, Kommunikation, Alternativen zur Dokumentation, Anforderungsdynamik, Sicherheitsanforderungen, Teamgröße, Qualitätssicherung.
- Quote paper
- Kai Jan Oey (Author), 2002, Dokumentation in der Softwareentwicklung - Effizienter Einsatz von Entwicklerdokumentation, Munich, GRIN Verlag, https://www.hausarbeiten.de/document/21755
