[thesis] Fixed mistakes, added examples for latex/doxygen. fixed style related issues
[hsd_doku_tool.git] / doc / thesis / chapters / einleitung.tex
1 \chapter{Einleitung}
2 \label{cha:Einleitung}
3
4 In diesem Kapitel wird die behandelte Problemstellung und Motivation der vorliegenden Arbeit dargestellt und eine Zielsetzung definiert.
5 Außerdem wird auf die Gliederung dieser Arbeit eingegangen und der Inhalt der einzelnen Kapitel kurz erläutert.
6
7 \section{Problemstellung und Motivation}
8 Da die Entwicklung von Software viel Zeit in Anspruch nimmt, und oft großem Zeitdruck entwickelt wird,
9 rückt die Dokumentation dieser meist in den Hintergrund. Das erschwert nicht nur die Einarbeitung neuer Entwickler
10 in bestehende Projekte, sondern auch die Wartung und Erweiterung von Programmcodes.
11 \newline
12 \par
13 Dies ist auch ein allgegenwärtiges Problem im Übungsbetrieb des Studienganges Hardware-Software-Design an der Fachhochschule Hagenberg. Da für die
14 Ausarbeitung der Softwareübungen keine einheitlichen Vorlagen verwendet werden und der Fokus meist nur auf die Umsetzung gelegt wird, leidet
15 darunter die Qualität der Dokumentationen.
16 \newline
17 \par
18 Es gibt zwar unterschiedliche Kommandozeilenprogramme, die den Dokumentationsprozess vereinfachen, die Handhabung dieser ist aber meist nicht trivial und
19 viele können nicht plattformunabhängig eingesetzt werden. Daher wird kaum Zeit in das Erlernen und Verwenden dieser Programme gesteckt.
20 \newline
21 \par
22 Zusammenfassend kann man sagen, dass gute Dokumentationen helfen Zeit und Geld zu sparen, da sie die Einarbeitungszeit in ein Projekt verkürzen.
23 Außerdem sind sie für Endanwender von großem Nutzen, da sie Unklarheiten beseitigen und Hemmschwellen einer neuen Anwendung gegenüber abbauen.
24 Deshalb befasst sich diese Arbeit mit Konzepten zur Software Dokumentation, mit Programmen, die diese Konzepte zum Teil bereits umsetzten
25 und der Zusammenführung dieser Programme in einen plattformunabhängigen Prototyp, der den Dokumentationsprozess vereinfachen soll.
26 Der Prototyp selbst wird so allgemein wie möglich konzipiert, damit er für verschiedene Typen von Software Projekten eingesetzt werden kann.
27 Als Grundlage hierfür werden die verschiedenen Softwareübungen im Übungsbetrieb des Studiengangs Hardware-Software-Design an der
28 Fachhochschule Hagenberg herangezogen.
29
30 \section{Zielsetzung}
31
32
33 Ziel dieser Arbeit ist es Dokumentationskonzepte zu beleuchten und auf Basis dieser, eine einfach zu bedienende grafische Benutzeroberfläche für
34 \textit{Linux} und \textit{Windows} zu entwickeln, die den Anwender beim Schreiben von Software Dokumentationen unterstützt,
35 indem sie verschiedene Arbeitsschritte für bestehende plattformunabhängige Kommandozeilenprogramme automatisiert.
36 \newline
37 \par
38 Damit sich ein Anwender nicht um Abhängigkeiten kümmern muss, müssen für diesen Prototyp die
39 Kommandozeilenprogramme in eine Programmumgebung zusammengefasst werden. Diese Programmumgebung soll zusammen mit dem Prototyp einfach
40 auf einem beliebigen \textit{Windows} oder \textit{Linux} Zielrechner eingerichtet werden können.
41 \newline
42 \par
43 Des Weiteren soll diese Software vom Anwender auswählbare, vordefinierte Dokumentationsvorlagen besitzen. Eine solche Vorlage definiert den
44 Ablauf des Dokumentationsprozesses und den Aufbau der generierten Dokumentation. Diese Vorlagen soll ein Anwender auch bearbeiten, selbst erstellen
45 und an andere Anwender weitergeben können.
46
47 \section{Gliederung dieser Arbeit}
48
49 Die vorliegende Arbeit ist in 7 verschiedene Kapitel gegliedert. Das erste \autoref{cha:Einleitung} umfasst die Motivation und Zielsetzung dieser
50 Arbeit.
51 \newline
52 \par
53 In \autoref{cha:Softwaredokumentationen} wird der Begriff der Dokumentation erläutert, wichtige Konzepte zum Dokumentieren in Software Projekten
54 beleuchtet und Kommandozeilenprogramme präsentiert die diese Konzepte umsetzen.
55 \newline
56 \par
57 Das \autoref{cha:Anforderungen} definiert den Funktionsumfang des Prototyps auf Basis der Konzepte aus \autoref{cha:Softwaredokumentationen} und
58 der durch die Software Übungsabgaben des Studiengangs Hardware-Software-Design an der Fachhochschule Hagenberg gegebenen Anforderungen.
59 \newline
60 \par
61 Der konzeptuelle Aufbau des Prototyps, das Zusammenspiel der einzelnen Komponenten und die Umsetzung der Plattformunabhängigkeit werden in
62 \autoref{cha:Konzept} festgelegt.
63 \newline
64 \par
65 Auf die Umsetzung des Prototyps mithilfe der festgelegten Konzepte aus \autoref{cha:Konzept} und die Lösung aller aufkommenden Probleme wird
66 in \autoref{cha:Projektumsetzung} eingegangen.
67 \newline
68 \par
69 In \autoref{cha:Tests} wird der Testablauf der verschiedenen Prototypentests erläutert. Außerdem beinhaltet dieses Kapitel eine Zusammenfassung
70 und Evaluierung aller Testergebnisse.
71 \newline
72 \par
73 Das letzte \autoref{cha:Zusammenfassung} umfasst die Zusammenfassung der Erkenntnisse dieser Arbeit und ein Fazit aus der Prototypenentwicklung.
74 Darüber hinaus werden in einem Ausblick Vorschläge für Verbesserungen und Erweiterungen des Prototyps formuliert.