Das Ziel der Arbeit ist es, die verschiedenen Anforderungen an eine gute und verständliche Softwaredokumentation zu erarbeiten und daraus Maßnahmen für die Effizienzsteigerung von Dokumentation abzuleiten.
Zunächst werden die theoretischen Grundlagen zu Dokumentationen und Softwaredokumentationen, sowie zu den verschiedenen Arten von Dokumentationen mit deren Vor- und Nachteilen erläutert. Darauf aufbauend werden die verschiedenen Anforderungen an eine gute und verständliche anwenderbezogene Software-Dokumentation erarbeitet. Aus diesen Anforderungen werden Maßnahmen für die effiziente Erstellung von Dokumentationen und die Steigerung der Effizienz von Dokumentationen abgeleitet.
Das Thema der Softwaredokumentation genießt in der Softwareentwicklung keinen guten Ruf und wird meist nur als notwendiges Übel betrachtet. Die Dokumentation wird nur ungern und verhältnismäßig schlecht ausgeführt. Das Problem mangelhafter Dokumentation ist allerdings bereits seit langem bekannt und wurde in der Vergangenheit auch immer wieder viel diskutiert. Eine qualitativ hochwertige Dokumentation ist insbesondere auch für die Endanwender der erstellten Produkte von großer Bedeutung. Komplizierte und unverständliche Dokumentationen führen zu Fehlern und Unlust in der Anwendung der Software. Eine gute Dokumentation verringert nicht nur die Aus- und Weiterbildungskosten des eingesetzten Personals, sondern baut darüber hinaus auch Hemmschwellen gegenüber der Anwendung ab.
Inhaltsverzeichnis
1. Einleitung
1.1. Problemstellung
1.2. Zielsetzung und Aufbau der Arbeit
2. Theoretische Grundlagen
2.1. Dokumentation und Softwaredokumentation
2.2. Arten von Softwaredokumentationen
3. Effizienzsteigerung von Dokumentationen
3.1. Anforderungen an eine gute und verständliche Dokumentation
3.2. Maßnahmen zur Effizienzsteigerungen bei Dokumentationen
4. Schlussbetrachtung
Zielsetzung und Themen der Arbeit
Das primäre Ziel dieser Ausarbeitung ist es, die verschiedenen Anforderungen an eine qualitativ hochwertige und verständliche Softwaredokumentation zu identifizieren und daraus konkrete Maßnahmen zur Effizienzsteigerung im Dokumentationsprozess abzuleiten.
- Grundlagen der Softwaredokumentation und ihre Bedeutung im Software-Lebenszyklus
- Klassifizierung verschiedener Arten von Softwaredokumentationen
- Analyse relevanter Normen und Qualitätskriterien für Dokumentationen
- Prozessorientierte Ansätze zur Effizienzsteigerung in der Erstellungsphase
- Methoden zur Qualitätssicherung und kontinuierlichen Anpassung von Dokumentationen
Auszug aus dem Buch
Systemdokumentation
Die Systemdokumentation enthält Dokumente, die für die Wartung und Weiterentwicklung der Software notwendig sind. Dazu gehören UML (Unified Modeling Language)-Diagramme oder Use-Case- und Szenario-Beschreibungen, die ursprüngliche Anforderungsspezifikation beziehungsweise das Lastenheft sowie eine Dokumentation der Systemarchitektur. Die Systemdokumentation betrachtet also übergreifend die Funktionsprinzipien der Software. Dadurch kann diese Dokumentation sehr umfangreich werden, es gilt also einen Kompromiss zwischen möglichst vollständiger Beschreibung und Umfang zu finden.
Zusammenfassung der Kapitel
1. Einleitung: Dieses Kapitel führt in die Problematik der Softwaredokumentation ein, die oft als notwendiges Übel betrachtet wird, und definiert die Ziele sowie den strukturellen Aufbau der Arbeit.
2. Theoretische Grundlagen: Hier werden die zentralen Begriffe Dokumentation und Softwaredokumentation definiert sowie verschiedene Arten der Dokumentation, unterteilt in betriebswirtschaftliche und technische Kategorien, vorgestellt.
3. Effizienzsteigerung von Dokumentationen: In diesem Hauptteil werden Anforderungen aus Normen abgeleitet und Maßnahmen erarbeitet, wie der Dokumentationsprozess durch Vorbereitung und kontinuierliche Anpassung effizienter gestaltet werden kann.
4. Schlussbetrachtung: Das abschließende Kapitel fasst die Erkenntnisse zusammen und betont die Notwendigkeit, Dokumentation als integralen, nicht-statischen Bestandteil des Softwareentwicklungsprozesses zu begreifen.
Schlüsselwörter
Softwaredokumentation, Systemdokumentation, Programmdokumentation, Benutzungsdokumentation, Effizienzsteigerung, Softwareentwicklung, Normenkonformität, Wissenskonservierung, Prozessoptimierung, Qualitätsmanagement, Dokumentationsmanagement, Nutzbarkeit, Software-Lebenszyklus, Anwenderorientierung.
Häufig gestellte Fragen
Worum geht es in dieser Arbeit grundsätzlich?
Die Arbeit befasst sich mit der Optimierung von Softwaredokumentationen, um diese von einem vernachlässigten Kostenfaktor zu einem wertvollen Bestandteil der Softwareentwicklung und -anwendung zu entwickeln.
Was sind die zentralen Themenfelder?
Die Schwerpunkte liegen auf der Definition von Qualitätskriterien für Dokumentationen, der Einordnung verschiedener Dokumentationsarten und der Darstellung von Strategien zur Steigerung der Effizienz im Erstellungsprozess.
Was ist das primäre Ziel oder die Forschungsfrage?
Das Ziel ist es, Anforderungen an eine verständliche Dokumentation zu erarbeiten und daraus fundierte Maßnahmen abzuleiten, um die Erstellung und Pflege von Dokumentationen effizienter zu gestalten.
Welche wissenschaftliche Methode wird verwendet?
Die Arbeit basiert auf einer Literaturanalyse, der Auswertung einschlägiger ISO/IEC/IEEE-Normen sowie der Untersuchung von Prozessmodellen zur Dokumentationserstellung.
Was wird im Hauptteil behandelt?
Der Hauptteil gliedert sich in die theoretische Begriffsbestimmung und die praktische Ableitung von Anforderungen und Maßnahmen, wobei insbesondere der Lebenszyklus der Dokumentation betrachtet wird.
Welche Schlüsselwörter charakterisieren die Arbeit?
Die Arbeit wird maßgeblich durch Begriffe wie Softwaredokumentation, Effizienzsteigerung, Normenkonformität und Anwenderorientierung geprägt.
Warum wird die Dokumentation in vielen Projekten vernachlässigt?
Sie wird oft als notwendiges Übel betrachtet, das im Wettbewerb mit dem Zeitdruck der Programmierung steht und selten als Teil der direkten Wertschöpfungskette gesehen wird.
Welche Rolle spielt die Aktualität einer Dokumentation?
Aktualität ist ein zentraler Effizienzfaktor, da eine veraltete Dokumentation ihren Nutzen für den Anwender verliert und bei der Pflege einen hohen organisatorischen Aufwand erfordert.
Wie kann eine Effizienzsteigerung konkret erreicht werden?
Durch eine frühzeitige Einbindung in das Projekt (nicht erst nach der Programmierung), die Verwendung geeigneter Werkzeuge und eine kontinuierliche Überprüfung durch Praxisbeispiele.
Was unterscheidet System- von Benutzungsdokumentation?
Die Systemdokumentation richtet sich primär an Entwickler und Wartungspersonal und beschreibt die Architektur, während die Benutzungsdokumentation den Endanwender bei der Bedienung und Nutzung des Softwareprodukts unterstützt.
- Quote paper
- Jessica Nagel (Author), 2018, Die Effizienzsteigerung von anwenderbezogenen Software-Dokumentationen. Anforderungen und Maßnahmen, Munich, GRIN Verlag, https://www.grin.com/document/509776
