fix various things in the documentation

This commit is contained in:
Andreas Zweili 2017-07-27 17:09:26 +02:00
parent 5c1f7e0465
commit 7a720ca87f
1 changed files with 111 additions and 28 deletions

View File

@ -97,23 +97,16 @@ Als Markbesucher möchte ich,
\newpage
\section{Use Cases}
In den Nachfolgenden Sektionen werden die einzelnenen User Stories in
Use Cases detailierter beschrieben. Wobei das Use Case Diagramm nur
einen groben Überblick über die möglichen Szenarien innerhalb der
Applikation gibt.
Für die Funktionen welche wir in der C\# Applikation effektiv umgesetzt
haben, haben wir die Use Cases im Detail beschrieben.
\subsection{Use Case Diagramm}
\subsection{Use Cases}
%% -- Begining of Use Case Template --
\subsubsection{User Registration}
\subsubsection{User Registrierung}
\begin{longtable}{|>{\columncolor[HTML]{EFEFEF}}p{.25\textwidth}|p{.7\textwidth}|}
\hline
%begin title row
{\cellcolor[HTML]{C0C0C0} Identifier} + Name & {\cellcolor[HTML]{C0C0C0} 1.0 User Registration} \\ \hline
{\cellcolor[HTML]{C0C0C0} Identifier} + Name & {\cellcolor[HTML]{C0C0C0} 1.0 User Registrierung} \\ \hline
%end title row
Description & Der Use Case beschreibt die Registrierung\\
& eines neuen User Accounts.\\
@ -149,7 +142,7 @@ Author & A. Zweili \& I. Cadaroski\\
\hline
Date & 20. Juli 2017\\
\hline
\caption{1.0 User Registration}
\caption{Use 1.0 User Registrierung}
\end{longtable}
\newpage
%% -- End of Use Case Template --
@ -192,7 +185,7 @@ Author & A. Zweili \& I. Cadaroski\\
\hline
Date & 20. Juli 2017\\
\hline
\caption{1.1 User Login}
\caption{Use Case 1.1 User Login}
\end{longtable}
\newpage
%% -- End of Use Case Template --
@ -233,11 +226,101 @@ Author & A. Zweili \& I. Cadaroski\\
\hline
Date & 20. Juli 2017\\
\hline
\caption{2.0 Standorte begutachten}
\caption{Use Case 2.0 Standorte begutachten}
\end{longtable}
\newpage
%% -- End of Use Case Template --
%% -- Begining of Use Case Template --
\subsubsection{Standorte mieten}
\begin{longtable}{|>{\columncolor[HTML]{EFEFEF}}p{.25\textwidth}|p{.7\textwidth}|}
\hline
%begin title row
{\cellcolor[HTML]{C0C0C0} Identifier} + Name & {\cellcolor[HTML]{C0C0C0} 2.1 Standorte mieten} \\ \hline
%end title row
Description & Der Use Case beschreibt das mieten der\\
& Standorte als Test Member.\\
\hline
Actors & User mit test$_{\text{member}}$ Status\\
\hline
Status & Freigegeben\\
\hline
Includes & -\\
\hline
Trigger & \\
\hline
Preconditions & UC 1.1 und 2.0 erfolgreich abgeschlossen\\
\hline
Postconditions & Miete wurde erfolgreich in DB eingetragen.\\
\hline
Normal Flow & 1. User wählt einen Standort aus\\
& 2. User wählt das Datum aus an dem er den\\
& Standort gerne mieten möchte.\\
& 3. User bestätigt die Miete mit klick auf\\
& den Insert Button.\\
\hline
Alternative Flow & 1. User wählt einen Standort aus\\
& 2. User wählt das Datum an dem er den\\
& Standort gerne mieten möchte.\\
& 3. User bestätigt die Miete mit klick auf\\
& den Insert Button.\\
& 4. Die Applikation meldet zurück das der\\
& Standort an diesem Datum bereits besetzt ist.\\
\hline
Notes & -\\
\hline
UC History & 1.0 Darft erstellt durch AZ\\
\hline
Author & A. Zweili \& I. Cadaroski\\
\hline
Date & 27. Juli 2017\\
\hline
\caption{Use Case 2.1 Standorte Mieten}
\end{longtable}
\newpage
%% -- End of Use Case Template --
%% -- Begining of Use Case Template --
\subsubsection{Mieten anzeigen}
\begin{longtable}{|>{\columncolor[HTML]{EFEFEF}}p{.25\textwidth}|p{.7\textwidth}|}
\hline
%begin title row
{\cellcolor[HTML]{C0C0C0} Identifier} + Name & {\cellcolor[HTML]{C0C0C0} 2.2 Mieten anzeigen} \\ \hline
%end title row
Description & Der Use Case beschreibt das Betrachten der\\
& getätigten Mieten des aktuellen Users.\\
\hline
Actors & User mit test$_{\text{member}}$ Status\\
\hline
Status & Freigegeben\\
\hline
Includes & -\\
\hline
Trigger & User möchte sich seine Mieten anzeigen lassen\\
\hline
Preconditions & UC 1.1, 2.1 erfolgreich abgeschlossen\\
\hline
Postconditions & Applikation gibt die Mieten des aktuellen\\
& Users aus.\\
\hline
Normal Flow & 1. User klickt auf ``update''\\
& 2. Die Applikation gibt die Details zu den\\
& Mieten des Users aus.\\
\hline
Alternative Flow & -\\
\hline
Notes & -\\
\hline
UC History & 1.0 Darft erstellt durch AZ\\
\hline
Author & A. Zweili \& I. Cadaroski\\
\hline
Date & 27. Juli 2017\\
\hline
\caption{Use Case 2.2 Mieten anzeigen}
\end{longtable}
\newpage
%% -- End of Use Case Template --
\newpage
\begin{landscape}
@ -446,19 +529,19 @@ aufgerufen werden.
Diese Klasse wurde für das Registrieren und Einloggen des Benutzers
mit einem dazugehörigen GUI von uns erstellt. Dadurch können sich
Benutzer durch das Eingeben der Email-Adresse und des Passwortes mit
dem "Register-Button" Registrieren und durch ein zweites eingeben der
Daten und betätigen des "Login-Button" auch gleich einloggen. Nach dem
dem ``Register-Button'' Registrieren und durch ein zweites eingeben der
Daten und betätigen des ``Login-Button'' auch gleich einloggen. Nach dem
Login wird auch gleich eine Nachricht der Applikation dem Benutzer mit
dem Text "It worked" aufgezeigt, um den erfolgreichen Login zu melden.
dem Text ``It worked'' aufgezeigt, um den erfolgreichen Login zu melden.
Dadurch möchten wir die Funktion des einfüllen und Lesen der Daten aus
der Datenbank aufzeigen. Den Verbindungsaufbau in die Datenbank mit
allen nötigen Funktion(Schreiben / Lesen) haben wir in die Klasse
"DataAccess" ausgelagert.
``DataAccess'' ausgelagert.
\textbf{Dashboard}
\newline
Auf dem Dashboard haben wir unseren Kern was Informationen herauslesen
und wieder Eingeben anbelangt, erstellt. In dieser Klasse werden die aus
und wieder Eingeben belangt, erstellt. In dieser Klasse werden die aus
der Datenbank herausgelesenen Daten der ``locations'' und
``rents'' Tabellen im GUI aufgezeigt und /oder eingefügt. Damit
möchten wir einen Teil unserer Applikation und Datenbank abbilden, mit
@ -478,18 +561,18 @@ Dadurch wird SQl- Code nur in dieser Klasse aufgerufen und verwendet.
\textbf{GetRents}
\newline
Um Daten herauszulesen oder zur Datenbank zu schicken, haben wir in C\#
ein Model der ``rents'' Tabelle erstellt die sie abbildet. Damit nehmen
wir jede Spalte der Tabelle entgegen. Danach werden mit der ``RentInfo''
Methode nur diejenigen Spalten der Tabelle für unser GUI abgerufen,
die wir auch wirklich benötigen. Jedoch wird die ``RentInfo'' Methode
noch nicht benötigt, da wir Daten nur einfügen und nicht herauslesen
möchten.
Um Daten herauszulesen oder zur Datenbank zu schicken, haben wir in
C\# ein Model der ``rents'' Tabelle erstellt die sie abbildet. Damit
nehmen wir jede Spalte der Tabelle entgegen. Danach werden mit der
``RentInfo'' Methode nur diejenigen Spalten der Tabelle für unser GUI
abgerufen, die wir auch wirklich benötigen. Jedoch wird die ``RentInfo''
Methode noch nicht benötigt, da wir Daten nur einfügen und nicht
herauslesen möchten.
\textbf{GetMembers}
\newline
Um Daten herauszulesen oder zur Datenbank zu schicken, haben wir in C\#
ein Model der ``members'' Tabelle erstellt die sie abbildet. Damit
Um Daten herauszulesen oder zur Datenbank zu schicken, haben wir in
C\# ein Model der ``members'' Tabelle erstellt die sie abbildet. Damit
nehmen wir jede Spalte der Tabelle entgegen. Danach werden mit der
``MemberInfo'' Methode nur diejenigen Spalten der Tabelle für unser GUI
abgerufen, die wir auch wirklich benötigen,um die Login Daten zu
@ -497,8 +580,8 @@ abgerufen, die wir auch wirklich benötigen,um die Login Daten zu
\textbf{GetLocations}
\newline
Um Daten herauszulesen oder zur Datenbank zu schicken, haben wir in C\#
ein Model der ``locations'' Tabelle erstellt die sie abbildet. Damit
Um Daten herauszulesen oder zur Datenbank zu schicken, haben wir in
C\# ein Model der ``locations'' Tabelle erstellt die sie abbildet. Damit
nehmen wir jede Spalte der Tabelle entgegen. Danach werden mit der
``LocationInfo'' Methode nur diejenigen Spalten der Tabelle für unser
GUI abgerufen, die wir auch wirklich benötigen.