Anwenderbezogene Softwaredokumentation. Kategorisierung und Gestaltung effizienter Dokumentationen

Studienarbeit aus dem Jahr 2020 im Fachbereich Informatik - Software, Note: 1,3, AKAD University, ehem. AKAD Fachhochschule Stuttgart, Sprache: Deutsch, Abstract: Die stetige Entwicklung von Technologien bewirkt eine Verbreitung immer komplex werdender IT-Produkte. Gleichzeitig steigt jedoch der Fachkräftemangel, während das Bildungsniveau in Industrienationen tendenziell sinkt. Ebenso besteht sowohl im privaten Sektor als auch bei viele Unternehmen keine Dringlichkeit für Schulungen von Softwareanwendung. Dieser Beitrag thematisiert die Herangehensweise zur strukturierten und nachhaltigen Erstellung effizienter Dokumentationen für Anwender im Rahmen eines Dokumentationsprozesses. Aufgrund der vielzähligen Möglichkeiten, den Begriff "Anwender" einzuordnen, umfasst dies ebenso die Unterscheidung der Zielgruppen und der dazugehörigen Dokumentationen.

Um der daraus entstehenden Diskrepanz entgegenzuwirken ist die Bereitstellung von qualitativ hochwertigen und effektiven Produktdokumentationen durch Unternehmen notwendig. Die Erstellung solcher Dokumentationen ist jedoch kostenintensiv. Daher belassen viele Unternehmen diese auf einem veralteten Stand oder erstellen einzelne Dokumente ohne direkten Bezug auf die jeweiligen IT-Prozesse. Für die Unternehmen bedeutet dies eine Notwendigkeit zur strukturierten und gezielten Planung, Kontrolle und Steuerung der Dokumentationsprozesse, damit ein deutlicher Mehrwert für das eigene Unternehmen und deren Anwender erzielt werden kann.

In die Thematik einleitend, erfolgt eine generelle Abgrenzung des Begriffs Dokumentation zur Softwaredokumentation. Dem anschließend werden die einzelne exemplarische Dokumentationsarten erörtert. Hierbei sollen sowohl ihre Vorteile als auch negative Auswirkungen und Risiken betrachtet werden. Im darauffolgenden Teil dieses Beitrages, wird die Erstellung effektiver Dokumentationen thematisiert. Dies umfasst sowohl häufige Problemfelder bei der Erstellung der Dokumente als auch mögliche gesetzliche Normen, die zu beachten sind. Zusätzlich wird die theoretische Vorgehensweise von nachhaltigen und wirksamen Dokumentationsprozessen beschrieben. Den Beitrag abschließend erfolgt eine kurze Zusammenfassung mit einem wertenden Fazit zum Dokumentationsprozess.