Die Effizienzsteigerung von anwenderbezogenen Software-Dokumentationen. Anforderungen und Massnahmen (PDF)

Studienarbeit aus dem Jahr 2018 im Fachbereich Informatik - Wirtschaftsinformatik, Note: 1,3, AKAD University, ehem. AKAD Fachhochschule Stuttgart, Veranstaltung: MIP63, Sprache: Deutsch, Abstract: Das Ziel der Arbeit ist es, die verschiedenen Anforderungen an eine gute und verständliche Softwaredokumentation zu erarbeiten und daraus Massnahmen 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 Massnahmen für die effiziente Erstellung von Dokumentationen und die Steigerung der Effizienz von Dokumentationen abgeleitet.

Das Thema der Softwaredokumentation geniesst in der Softwareentwicklung keinen guten Ruf und wird meist nur als notwendiges Übel betrachtet. Die Dokumentation wird nur ungern und verhältnismässig 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 grosser 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.