docs: add docs

projektdokumentation/Anhang/AnhangBenutzerDoku.tex

@@ -0,0 +1,15 @@
+\subsection{Benutzerdokumentation}
+\label{app:BenutzerDoku}
+Ausschnitt aus der Benutzerdokumentation:
+
+\begin{table}[htb]
+\begin{tabularx}{\textwidth}{cXX}
+\rowcolor{heading}\textbf{Symbol} & \textbf{Bedeutung global} & \textbf{Bedeutung einzeln} \\
+\includegraphicstotab[]{weather-clear.png} & Alle Module weisen den gleichen Stand auf. & Das Modul ist auf dem gleichen Stand wie das Modul auf der vorherigen Umgebung. \\
+\rowcolor{odd}\includegraphicstotab[]{weather-clear-night.png} & Es existieren keine Module (fachlich nicht möglich). & Weder auf der aktuellen noch auf der vorherigen Umgebung sind Module angelegt. Es kann also auch nichts übertragen werden. \\
+\includegraphicstotab[]{weather-few-clouds-night.png} & Ein Modul muss durch das Übertragen von der vorherigen Umgebung erstellt werden. & Das Modul der vorherigen Umgebung kann übertragen werden, auf dieser Umgebung ist noch kein Modul vorhanden. \\
+\rowcolor{odd}\includegraphicstotab[]{weather-few-clouds.png} & Auf einer vorherigen Umgebung gibt es ein Modul, welches übertragen werden kann, um das nächste zu aktualisieren. & Das Modul der vorherigen Umgebung kann übertragen werden um dieses zu aktualisieren. \\
+\includegraphicstotab[]{weather-storm.png} & Ein Modul auf einer Umgebung wurde entgegen des Entwicklungsprozesses gespeichert. & Das aktuelle Modul ist neuer als das Modul auf der vorherigen Umgebung oder die vorherige Umgebung wurde übersprungen. \\
+\end{tabularx}
+\end{table}
+

projektdokumentation/Anhang/AnhangDoc.tex

@@ -0,0 +1,7 @@
+\subsection{Entwicklerdokumentation}
+\label{app:Doc}
+\begin{center}
+\includegraphics[page=1, width=0.9\textwidth]{doc.pdf}
+
+\includegraphics[page=2, width=0.9\textwidth]{doc.pdf}
+\end{center}

projektdokumentation/Anhang/AnhangEntwuerfe.tex

@@ -0,0 +1,19 @@
+\subsection{Oberflächenentwürfe}
+\label{app:Entwuerfe}
+\begin{figure}[htb]
+\centering
+\includegraphicsKeepAspectRatio{MockupModules.pdf}{0.7}
+\caption{Liste der Module mit Filtermöglichkeiten}
+\end{figure}
+
+\begin{figure}[htb]
+\centering
+\includegraphicsKeepAspectRatio{MockupModul.pdf}{0.7}
+\caption{Anzeige der Übersichtsseite einzelner Module}
+\end{figure}
+
+\begin{figure}[htb]
+\centering
+\includegraphicsKeepAspectRatio{MockupTag.pdf}{0.7}
+\caption{Anzeige und Filterung der Module nach Tags}
+\end{figure}

projektdokumentation/Anhang/AnhangLastenheft.tex

@@ -0,0 +1,22 @@
+\subsection{Lastenheft (Auszug)}
+\label{app:Lastenheft}
+Im folgenden Auszug des Lastenheftes werden die Anforderungen definiert, die an die neu entwickelte Anwendung gestellt werden.
+
+Die Anwendung muss folgende Anforderungen erfüllen:
+\begin{enumerate}[itemsep=0em,partopsep=0em,parsep=0em,topsep=0em]
+\item Verarbeitung der empfangenen Daten von \ac{IX}
+	\begin{enumerate}
+	\item Die Anwendung muss Produkt- und Nutzerdaten von der \ac{IX}-\ac{API} abrufen können.
+	\item Die geholten Daten sollen temporär zwischengespeichert werden, um den Import zu \ac{M2} von der Datenbeschaffung abzukapseln
+	\item Die gespeicherten Daten werden getrennt von der \ac{IX}-\ac{API} an die \ac{M2} Import-Funktionen gegeben und so in das \ac{M2} System integriert
+	\end{enumerate}
+\item Sonstige Anforderungen
+	\begin{enumerate}
+	\item Die Anwendung muss ohne das Installieren einer zusätzlichen Software über das Terminal erreichbar sein.
+	\item Die Import der Daten muss jede Nacht \bzw nach jedem Fehlschlag automatisch aktualisiert werden.
+	\item Die Anwendung soll jederzeit erreichbar sein.
+	\item Da sich die Entwickler auf die Anwendung verlassen, muss diese korrekte Daten liefern und darf keinen Interpretationsspielraum lassen.
+	\item Die Anwendung muss so flexibel sein, dass sie bei Änderungen im Entwicklungsprozess einfach angepasst werden kann.
+	\end{enumerate}
+\end{enumerate}
+

projektdokumentation/Anhang/AnhangPflichtenheft.tex

@@ -0,0 +1,52 @@
+\subsection{Pflichtenheft (Auszug)}
+\label{app:Pflichtenheft}
+
+\subsubsection*{Zielbestimmung}
+
+\begin{enumerate}[itemsep=0em,partopsep=0em,parsep=0em,topsep=0em]
+\item Musskriterien % Wikipedia: für das Produkt unabdingbare Leistungen, die in jedem Fall erfüllt werden müssen
+	\begin{enumerate}
+	\item Modul-Liste: Zeigt eine filterbare Liste der Module mit den dazugehörigen Kerninformationen sowie Symbolen zur Einhaltung des Entwicklungsprozesses an
+		\begin{itemize}
+		\item In der Liste wird der Name, die Bibliothek und Daten zum Source und Kompilat eines Moduls angezeigt.
+		\item Ebenfalls wird der Status des Moduls hinsichtlich Source und Kompilat angezeigt. Dazu gibt es unterschiedliche Status-Zeichen, welche symbolisieren in wie weit der Entwicklungsprozess eingehalten wurde \bzw welche Schritte als nächstes getan werden müssen. So gibt es \zB Zeichen für das Einhalten oder Verletzen des Prozesses oder den Hinweis auf den nächsten zu tätigenden Schritt. 
+		\item Weiterhin werden die Benutzer und Zeitpunkte der aktuellen Version der Sourcen und Kompilate angezeigt. Dazu kann vorher ausgewählt werden, von welcher Umgebung diese Daten gelesen werden sollen. 
+		\item Es kann eine Filterung nach allen angezeigten Daten vorgenommen werden. Die Daten zu den Sourcen sind historisiert. Durch die Filterung ist es möglich, auch Module zu finden, die in der Zwischenzeit schon von einem anderen Benutzer editiert wurden.
+		\end{itemize}
+	\item Tag-Liste: Bietet die Möglichkeit die Module anhand von Tags zu filtern. 
+		\begin{itemize}
+		\item Es sollen die Tags angezeigt werden, nach denen bereits gefiltert wird und die, die noch der Filterung hinzugefügt werden könnten, ohne dass die Ergebnisliste leer wird.
+		\item Zusätzlich sollen die Module angezeigt werden, die den Filterkriterien entsprechen. Sollten die Filterkriterien leer sein, werden nur die Module angezeigt, welche mit einem Tag versehen sind.
+		\end{itemize}
+	\item Import der Moduldaten aus einer bereitgestellten \acs{CSV}-Datei
+		\begin{itemize}
+		\item Es wird täglich eine Datei mit den Daten der aktuellen Module erstellt. Diese Datei wird (durch einen Cronjob) automatisch nachts importiert.
+		\item Dabei wird für jedes importierte Modul ein Zeitstempel aktualisiert, damit festgestellt werden kann, wenn ein Modul gelöscht wurde.
+		\item Die Datei enthält die Namen der Umgebung, der Bibliothek und des Moduls, den Programmtyp, den Benutzer und Zeitpunkt des Sourcecodes sowie des Kompilats und den Hash des Sourcecodes.
+		\item Sollte sich ein Modul verändert haben, werden die entsprechenden Daten in der Datenbank aktualisiert. Die Veränderungen am Source werden dabei aber nicht ersetzt, sondern historisiert.
+		\end{itemize}
+	\item Import der Informationen aus \ac{SVN}. Durch einen \gqq{post-commit-hook} wird nach jedem Einchecken eines Moduls ein \acs{PHP}-Script auf der Konsole aufgerufen, welches die Informationen, die vom \ac{SVN}-Kommandozeilentool geliefert werden, an \acs{NatInfo} übergibt.
+	\item Parsen der Sourcen
+		\begin{itemize}
+		\item Die Sourcen der Entwicklungsumgebung werden nach Tags, Links zu Artikeln im Wiki und Programmbeschreibungen durchsucht.
+		\item Diese Daten werden dann entsprechend angelegt, aktualisiert oder nicht mehr gesetzte Tags/Wikiartikel entfernt.
+		\end{itemize}
+	\item Sonstiges
+		\begin{itemize}
+		\item Das Programm läuft als Webanwendung im Intranet.
+		\item Die Anwendung soll möglichst leicht erweiterbar sein und auch von anderen Entwicklungsprozessen ausgehen können.
+		\item Eine Konfiguration soll möglichst in zentralen Konfigurationsdateien erfolgen.
+		\end{itemize}
+	\end{enumerate}
+\end{enumerate}
+
+\subsubsection*{Produkteinsatz}
+
+\begin{enumerate}[itemsep=0em,partopsep=0em,parsep=0em,topsep=0em]
+\item{Anwendungsbereiche\\
+Die Webanwendung dient als Anlaufstelle für die Entwicklung. Dort sind alle Informationen für die Module an einer Stelle gesammelt. Vorher getrennte Anwendungen werden ersetzt \bzw verlinkt.}
+\item{Zielgruppen\\
+\NI wird lediglich von den \ac{Natural}-Entwicklern in der EDV-Abteilung genutzt.}
+\item{Betriebsbedingungen\\ % Wikipedia: physikalische Umgebung des Systems, tägliche Betriebszeit, ständige Beobachtung des Systems durch Bediener oder unbeaufsichtigter Betrieb
+Die nötigen Betriebsbedingungen, also der Webserver, die Datenbank, die Versionsverwaltung, das Wiki und der nächtliche Export sind bereits vorhanden und konfiguriert. Durch einen täglichen Cronjob werden entsprechende Daten aktualisiert, die Webanwendung ist jederzeit aus dem Intranet heraus erreichbar.}
+\end{enumerate}

projektdokumentation/Anhang/AnhangRessourcen.tex

@@ -0,0 +1,28 @@
+\subsection{Verwendete Ressourcen}
+\label{app:Ressourcen}
+ Hardware
+\begin{itemize}
+    \item Büroarbeitsplatz (Schreibtisch, ergonomischer Stuhl)
+    \item Fujitsu Lifebook U-Series - Notebook
+    \item Peripheriegeräte für Notebook (Tastatur, Maus)
+\end{itemize}
+
+Software
+\begin{itemize}
+    \item Debian Derivat Ubuntu 18.04 - Betriebssystem
+    \item JetBrains PHPStorm - Entwicklungsumgebung \ac{PHP}
+    \item git - Verteilte Versionsverwaltung
+    \item Docker - Open Source Management von virtuellen Maschinen (Containerbasiert)
+    \item mySQL - Open Source relationelles Datenbank Management System
+    \item Composer - Open Source Package Management System auf Anwendungsebene für \ac{PHP}
+    \item Magento 2 Community Edition - Open Source \ac{eCommerce} Platform
+    \item TeXify IDEA - Open Source Plugin für PHPStorm als Distribution des Textsatzsystems TeX
+    \item PHPUnit - Framework zur Durchführung von Unit-Tests
+    \item LaTeX-Vorlage zur IHK-Projektdokumentation für Fachinformatiker Anwendungsentwicklung von Stefan Macke - \url{http://fiae.link/LaTeXVorlageFIAE}
+\end{itemize}
+
+Personal
+\begin{itemize}
+    \item Mitarbeiter Softwareentwicklung der \ac{NSD} - Festlegung der Anforderungen, Abnahme des Projektes \& Review des Codes
+    \item Auszubildender Fachinformatiker als Entwickler - Umsetzung des Projektes
+\end{itemize}

projektdokumentation/Anhang/AnhangScreenshots.tex

@@ -0,0 +1,14 @@
+\subsection{Screenshots der Anwendung}
+\label{Screenshots}
+\begin{figure}[htb]
+\centering
+\includegraphicsKeepAspectRatio{tagliste.pdf}{1}
+\caption{Anzeige und Filterung der Module nach Tags}
+\end{figure}
+\clearpage
+\begin{figure}[htb]
+\centering
+\includegraphicsKeepAspectRatio{modulliste.pdf}{1}
+\caption{Liste der Module mit Filtermöglichkeiten}
+\end{figure}
+\clearpage

projektdokumentation/Anhang/AnhangTest.tex

@@ -0,0 +1,9 @@
+\subsection{Testfall und sein Aufruf auf der Konsole}
+\label{app:Test}
+\lstinputlisting[language=php, caption={Testfall in PHP}]{Listings/tests.php}
+\clearpage
+\begin{figure}[htb]
+\centering
+\includegraphicsKeepAspectRatio{testcase.jpg}{1}
+\caption{Aufruf des Testfalls auf der Konsole}
+\end{figure}