Feature Complete

Praktikum2/ppm1/doc/documentation.md

@@ -1,36 +1,57 @@
-# Web-Praktikum Gruppe K
-## Kai Wansart und Felix Hoster
-### 16.11.2016
-
-## Beschreibung der Lösung
-### Aufgabe der Anwendung: 
-Die Praktikumsaufgabe war, eine Ünterstützung der Betreuung von Praxisphasen mit einer Web-Anwendung zu erstellen. Praxisphasen werden
-von externen Partnern (Firmen) angeboten, Studenten können diese Angebote nutzen, wenn sie einen Lehrenden als Betreuer
-finden 
- 
- #### Übersicht der fachlichen Funktion
- - Datenpflege Studenten: Eine Liste mit allen erstellten Studenten (Name, Vorname, Matrikelnummer)
- - Datenpflege Lehrende: Eine Übersicht mit allen Lehrenden (Name, Titel, Lehrgebiet)
- - Datenpflege Firmenverzeichniss: Eine Liste mit einer kleinen Übersicht über einzelne Firmen (Schwerpunkt, Sitz, Name, Branche, Mitarbeiteranzahl)
- - Datenpflege Praxisphase: Erhält man eine kurze Übersicht über Angebote für die Studenten (Firmenbetreuer, Beschreibung, Name, Voraussetzung, Firma)
- - Auswahl Praxisphasen: Dort können die Studenten mit einem Professor sich eine Praxisphase aussuchen
- - Auswertung Firma: Hier werden die Firmen bewertet, die ein Angebot für die Praxisphase bewertet
- - Auswertung Praxisphasen nach Studenten: Hier sieht man die Bewertung der Studenten über die einzelnen Angebote
- - Auswertung Praxisphase nach Betreuern: Hier sieht man die Bewertung der Praxisphasen - Betreuer
- 
-
-## Beschreibung des Servers
-#### Zweck
-
-#### Aufbau (Bestandteile der Komponente)
-
-#### Zusammenwirken mit anderen Komponenten
-
-#### API (Programmierschnittstellen), die die Leistung der Komponente anbieten
-
-## Datenablage
-Die Daten werden mittels der Kategorie abgespeichert, die als Variable behandelt wird. Mit dieser Variable wird die Datei immer wieder neu gespeichert, wenn etwas gelöscht bzw. geändert wird. Das Format der Datei ist eine JSON-Datei, die im Ordner 'Data' und der darauffolgenden Kategorie abgespeichert wird. 
-
-## Konfiguration
-
+# Web-Praktikum Gruppe A
+## Kai Wansart 921862 und Felix Hoster xxxxxx
+### 15.12.2016
+
+## Beschreibung der Lösung
+### Aufgabe der Anwendung: 
+- Entwickeln und Umsetzen eines Praxisphasenmanagers (PPM).
+- Schnittstelle für Firmen, Dozenten und Studenten
+- Verwaltung der Daten, zB. Benutzerverwaltung und Angebotverwaltung
+
+
+ 
+ #### Übersicht der fachlichen Funktion
+ - Datenpflege Studenten: 
+    - Ausgabe Studenten im System
+    - Verwaltung bestehender Datensätze
+    - Erstellen neuer Datensätze
+ - Datenpflege Lehrende:
+    - Ausgabe Lehrenden im System
+    - Verwaltung bestehender Datensätze
+    - Erstellen neuer Datensätze
+ - Datenpflege Firmenverzeichnis:
+    - Ausgabe Firmen im System
+    - Verwaltung bestehender Datensätze
+    - Erstellen neuer Datensätze
+ - Datenpflege Praxisphase:
+    - Ausgabe Angebote Praxiphasenplätze im System
+    - Verwaltung bestehender Datensätze
+    - Erstellen neuer Datensätze
+ - Auswahl Praxisphasen:
+    - Schnittstelle für Studenten, um sich in Praxisphasenplatz einzuschreiben, mit Angabe von Zeitraum
+ - Auswertung Firma:
+    - Ausgabe aller Firmen mit den jeweiligen Studenten, die sich bei Ihnen zu einem Praxisphasenplatz eingeschrieben haben
+ - Auswertung Praxisphasen nach Studenten: 
+    - Ausgabe aller Studenten mit Informationen, bei welcher Firma sie wann ihre Praxisphase machen / gemacht haben
+ - Auswertung Praxisphase nach Betreuern:
+    - Ausgabe aller Betreuer mit den jeweiligen Studenten, die sie betreuen.
+
+## Beschreibung des Servers
+#### Zweck
+- Firmen die Möglichkeit geben, Studenten Praxisphasenplätze anzubieten
+- Studenten die Möglichkeit geben, Praxisphasenplätze auszuwählen
+- Auswertungen anbieten
+
+#### Aufbau (Bestandteile der Komponente)
+- 
+
+#### Zusammenwirken mit anderen Komponenten
+
+#### API (Programmierschnittstellen), die die Leistung der Komponente anbieten
+
+## Datenablage
+Die Daten werden mittels der Kategorie abgespeichert, die als Variable behandelt wird. Mit dieser Variable wird die Datei immer wieder neu gespeichert, wenn etwas gelöscht bzw. geändert wird. Das Format der Datei ist eine JSON-Datei, die im Ordner 'Data' und der darauffolgenden Kategorie abgespeichert wird. 
+
+## Konfiguration
+
 ## Durchführung und Ergebnis der geforderten Prüfungen