In der vorliegenden Masterarbeit wird das Thema Softwaredokumentation behandelt und

aufgezeigt, wie der derzeitige Stand in der Theorie und in der Praxis aussieht, welche

Herausforderungen aktuell noch auftreten und welche innovativen Lösungsansätze es für

diese gibt.

Die Dokumentation ist ein essenzieller Bestandteil in der Softwareentwicklung, damit

zukünftige Anwender, Entwickler und Administratoren alle wichtigen Informationen

erhalten, die sie für die Nutzung, Weiterentwicklung, Einführung oder Wartung benötigen.

Aus diesem Grund ist es notwendig, dass die Softwaredokumentation eine hohe Qualität

aufweist. Dies ist jedoch aufgrund von Schwierigkeiten, mit denen die Autoren aktuell noch

konfrontiert werden, häufig nicht der Fall.

Das Ziel der Masterarbeit ist es, die in der Praxis auftretenden Herausforderungen

aufzuzeigen und mögliche Lösungsansätze näherzubringen. Um dies zu erreichen, wird

zunächst eine ausführliche Literaturrecherche durchgeführt. Dabei werden die

sequenziellen und agilen Vorgehensmodelle sowie deren Liefergegenstände beschrieben

und auf Schwierigkeiten dieser drei Themenbereiche eingegangen. Infolgedessen ergeben

sich Thesen, aus denen Fragen als Grundlage für die Durchführung von

Experteninterviews aufgestellt werden. Die daraus resultierenden Ergebnisse werden den

zuvor bestimmten Behauptungen gegenübergestellt, um diese zu bestätigen und somit

hervorzuheben, welche Herausforderungen in der Praxis aktuell noch auftreten.

Aus den Befragungen geht hervor, dass es bei den Anwendern häufig zu

Verständnisschwierigkeiten kommt, wenn die Softwaredokumentation von den Entwicklern

selbst geschrieben wurde. Außerdem wird gezeigt, dass vereinzelt Unternehmen nicht von

Tools für die Zusammenarbeit und die Anfertigung der Dokumentation profitieren. Auch die

Ablage und Versionierung der Dokumente ist teilweise noch unzureichend. Des Weiteren

stellt sich als Problem heraus, dass bei mangelnder Zeit bis zum Auslieferungstermin an

erster Stelle bei der Softwaredokumentation Einsparungen vorgenommen werden. Auch

das zielgruppengerechte Schreiben stellt sich als Herausforderung für die Autoren heraus,

da die Anwender weder erfragt noch analysiert werden. Darüber hinaus werden die

Projektbeteiligten, die für die Dokumentation verantwortlich sind, nicht ausreichend für die

Erstellung dieser geschult.

Um diese Herausforderungen bezüglich der Erstellung von Softwaredokumentationen in

Zukunft zu minimieren, werden einige Lösungsansätze vorgestellt. Diese sollen

Unternehmen und Projektbeteiligte dabei unterstützen, die Bedeutsamkeit der

Dokumentation zu erkennen und die bestehenden Schwierigkeiten zu bewältigen.

This master's thesis deals with the topic of software documentation and shows what the

current status is in theory and practice, what challenges are currently occurring and what

innovative solutions there are for them. Documentation is an essential part of software

development so that future users, developers and administrators receive all the important

information they need for use, further development, introduction or maintenance. For this

reason, it is necessary that the software documentation is of high quality. However, this is

often not the case due to difficulties currently faced by authors. The aim of the master's

thesis is to highlight the challenges that arise in practice and to provide possible solutions.

In order to achieve this, firstly a detailed literature research is carried out. The sequential

and agile process models and their deliverables are described and difficulties in these three

subject areas are discussed. As a result, theses emerge from which questions are drawn

up as a basis for conducting expert interviews. The developed results are compared to the

previously determined claims in order to confirm them and thus highlight which challenges

still arise in practice. The surveys show that users often have difficulty understanding when

the software documentation is written by the developers themselves. It also shows that

some companies do not benefit from tools for collaboration and documentation creation.

The storage and versioning of documents is also still inadequate in some cases. Another

challenge is that if there is not enough time until the delivery date, savings are made

primarily in software documentation. Writing for the target group also proves to be a

challenge for the authors, as users are neither asked nor analyzed. In addition, those

involved in the project who are responsible for the documentation are not adequately

trained to create it. In order to minimize these challenges regarding the creation of software

documentation in the future, some possible solutions are presented. These are intended to

support companies and project participants in recognizing the importance of the

documentation and in overcoming the existing difficulties.