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
- Einleitung
- Problemstellung
- Einordnung und Ziel der Arbeit
- Vorgehensweise
- Erläuterung verwendeter Begriffe
- Entwicklerdokumentation
- Gegenstände der Entwicklerdokumentation
- Gründe für Entwicklerdokumentation
- Wissenskonservierung
- Wissenstransfer
- Koordination
- Kommunikation
- Softwareerstellungs-Vertrag
- Organisatorische Politik und Macht
- Strukturierung der Implementierung
- Durchdringung inhaltlicher Konzepte
- Geforderte Qualitätsstandards
- Dokumentationsvorgaben
- Nachteile von Entwicklerdokumentation
- Aktualität
- Aktualisierungsaufwand
- Verständlichkeit
- Informationsfindung
- Zusätzlicher Ressourcenbedarf
- Motivationsproblem
- Effizienzsteigerung des Einsatzes von Entwicklerdokumentation
- Effizienz von Entwicklerdokumentation
- Maßnahmen zur Effizienzsteigerung
- Grundkonzepte und Qualitätsanforderungen
- Quantitative Aspekte
- Alternativen zu traditionellen Ansätzen der Dokumentation
- Kritische Beleuchtung weiterer und genannter Vorschläge
- Zeitpunkt von Dokumentation
- Technische Hilfsmittel
- Video- und Audioaufnahmen als Dokumentation
- Kompletter Dokumentationsverzicht
- Positive Aspekte von Redundanzen
- Unnötigkeit richtiger und aktueller Dokumentation
- Teamgröße und angemessene direkte Kommunikation
- Öffentliche Präsentation und Prozessdokumentation
- Einflussfaktoren auf Entwicklerdokumentation
- Organisatorische Einflussfaktoren
Zielsetzung und Themenschwerpunkte
Die Diplomarbeit untersucht die Effizienz von Entwicklerdokumentation im Kontext der Softwareentwicklung. Sie analysiert die Gründe für und gegen die Erstellung von Dokumentationen, beleuchtet die Herausforderungen im Zusammenhang mit Aktualität, Aktualisierungsaufwand und Verständlichkeit und präsentiert verschiedene Maßnahmen zur Effizienzsteigerung. Dabei werden sowohl traditionelle Ansätze wie integrierte Dokumentation und hohe Lesbarkeit als auch alternative Ansätze wie Pair Programming, direkte Kommunikation und öffentliche Präsentationen betrachtet.
- Gründe für und gegen Entwicklerdokumentation
- Herausforderungen der Entwicklerdokumentation (Aktualität, Aktualisierungsaufwand, Verständlichkeit)
- Maßnahmen zur Effizienzsteigerung der Entwicklerdokumentation
- Einflussfaktoren auf die Effizienz von Entwicklerdokumentation
- Bewertung verschiedener Ansätze und deren Eignung für unterschiedliche Softwareentwicklungsprojekte
Zusammenfassung der Kapitel
Die Einleitung stellt die Problemstellung der Entwicklerdokumentation dar und definiert das Ziel der Arbeit. Kapitel 2 beleuchtet die Gegenstände und Gründe für die Erstellung von Entwicklerdokumentation, sowie die damit verbundenen Nachteile. Kapitel 3 widmet sich der Effizienzsteigerung von Entwicklerdokumentation, indem es verschiedene Maßnahmen und Ansätze untersucht. Dabei werden auch kritische Aspekte und Limitationen der einzelnen Maßnahmen betrachtet. Kapitel 4 analysiert die Einflussfaktoren auf die Effizienz von Entwicklerdokumentation, wobei insbesondere organisatorische Einflussfaktoren im Fokus stehen.
Schlüsselwörter
Entwicklerdokumentation, Softwareentwicklung, Effizienzsteigerung, Aktualität, Aktualisierungsaufwand, Verständlichkeit, Pair Programming, direkte Kommunikation, öffentliche Präsentation, Einflussfaktoren, organisatorische Einflussfaktoren
- Arbeit zitieren
- Kai Jan Oey (Autor:in), 2002, Dokumentation in der Softwareentwicklung - Effizienter Einsatz von Entwicklerdokumentation, München, GRIN Verlag, https://www.grin.com/document/21755
