[Task] Add Documentation

documentation/microservice_stock/chapter/Anforderungen.tex

@@ -1,53 +0,0 @@
-\section{Definition der Anforderungen}
-\label{sec: Definition der Anforderungen}
-
-Der Microservice Warenwirtschaft dient der Verwaltung der Warenbestände für den Webshop Mosh. Die nachfolgende Tabelle \ref{tabl:Begriffe} definiert die hier verwendeten Begriffe, so wie sie in dem Code und innerhalb dieser Dokumentation genutzt werden.
-\begin{table}[H]
-\begin{small}
-	\begin{center}
-  	\caption{Begriffsdefinition}
-   	\renewcommand{\arraystretch}{1.0}
-    \begin{tabularx}{\textwidth}{|L{2.2cm}|L{4cm}|X|}
-
-    \hline
-
-    \textbf{Begriff} & \textbf{Englische Übersetzung} &\textbf{Bedeutung}\\ \hline
-
-    Produkt & Product & Über den Webshop angebotene Früchte- oder Gemüseart, zum Beispiel Kiwis\\ \hline
-	Ware & Good & Einzelne Frucht oder einzelnes Gemüse pro Produkt (zum Beispiel eine Kiwi)\\ \hline
-	Warenbestand & Stock & Anzahl der einzelnen Waren pro Produkt, die sich im Lager befinden\\ \hline
-
-	\end{tabularx}
-	\label{tabl:Begriffe}
-	\end{center}
-\end{small}
-\end{table}
-
-Die übergeordnete Aufgabe dieses Microservice ist die Speicherung und Verwaltung der Waren mit ihrem Lagerort sowie einem Ablaufdatum, da es sich bei Obst und Gemüse um verderbliche Waren handelt. Nachfolgend sind die weiteren, detaillierten Anforderungen an diesen Microservice zusammengefasst.
-
-\begin{itemize}
-	\item \textbf{Funktionen des Admin-Frontends}
-	\begin{itemize}
-		\item Hinzufügen neuer Waren zum Warenbestand
-		\item Manuelles Entfernen von Waren aus dem Warenbestand, zum Beispiel wenn diese verdorben sind
-	\end{itemize}
-	\item \textbf{Funktionen für andere Mircoservice / dem Beispiel Warenkorb}
-	\begin{itemize}
-		\item Entfernen von einzelnen Waren aus dem Warenbestand, wenn diese an einen Kunden versendet werden
-		\item Blockieren von Waren in dem Warenbestand, wenn ein Kunde diese in seinen Warenkorb gelegt hat
-		\item Automatische Freigabe von blockierten Waren, wenn diese nicht innerhalb einer Frist an den Versand überstellt werden
-	\end{itemize}
-	\item \textbf{Funktionen des Kunden-Frontends}
-	\begin{itemize}
-		\item Anzeige des Warenbestands über ein Ampelsystem
-	\end{itemize}
-	\item \textbf{Optionale Zusatzfunktionen}
-	\begin{itemize}
-		\item Admin-Frontend: Ausgabe einer Statistik, wie viele Waren sich gesamt und durchschnittlich im Warenbestand befinden
-		\item Admin-Frontend: Ampeldarstellung pro Ware, die Anzeigt ob diese bereits ihr angegebenes Ablaufdatum erreicht oder überschritten hat
-	\end{itemize}
-\end{itemize}
-\newpage
-Die Angabe der Anzahl ist bei dem Hinzufügen neuer Waren zum Warenbestand verpflichtend, da ohne sie die Verwaltung neu eingetroffener Waren nicht möglich ist. Gleiches gilt für die Angabe des Ablaufdatums, diese ist speziell bei der Verwaltung von Lebensmitteln notwendig, um den Verkauf von verdorbenen Waren zu vermeiden. Die Datumsangabe erfolgt dabei im amerikanischen Format \textit{Jahr-Monat-Tag}. \par
-Im Gegensatz dazu sind die Angabe von Lagerplatz und Kommentar bei dem Hinzufügen neuer Waren optional, da diese Informationen für die Verwaltung des reinen Warenbestandes nicht essentiell notwendig sind. Diese beiden Angaben sind als Freitextfelder umzusetzen, um speziell bei dem Lagerort flexibel die Nutzung verschiedener Benennungschema für Regale oder Lagerräume zu ermöglichen und den Benutzer hier nicht einzuschränken. \par
-Der Microservice ist in den bestehenden Monolithen Mosh zu integrieren, eine Kommunikation mit anderen Microservices wird jedoch nicht hergestellt.