gitlab
/
EVA_Lernsituation
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
185 Commits
10 Branches
0 Tags
26 MiB
Tree: 11738e8ba5
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '11738e8ba5'
${ noResults }
EVA_Lernsituation/_Dokumente/Ausgearbeitete Dokumente/Pflichtenheft.md

17 KiB
Raw Blame History

Pflichtenheft

Inhalt

Zielbestimmung

Das Ziel von Parsec Iron Puffin (PIP) ist es, eine Anwendung zu bieten welche die Organisation der Musikschule erlaubt. Hierzu werden für Dozenten und Verwaltung verschiedene administrative Funktionen bereitgestellt. Die aktuellen Betriebsprozesse sollen vereinfacht und beschleunigt werden.

Die Anwendung bietet der Verwaltung Übersichten über die Schüler, Dozenten, Kurse und Finanzen. Es können Schüler der Kurse und Dozenten der Schüler angezeigt werden.

Der Dozent erhält eine Übersicht über die Stunden, welche er in der Woche zu unterrichten hat. Außerdem kann er eine Detailansicht eines Kurses aufrufen, welche ihm Informationen über die Schüler in diesem Kurs und die Unterrichtsinhalte der vergangenen Stunden bietet.

Nutzer können mithilfe der Anwendung Kurse beantragen und "Band"-Kursen beitreten.

Musskriterien

  • Es besteht eine Authentifizierung um den Zugriff auf alle Funktionen auf die jeweils berechtigten Personen zu beschränken.
  • Der Dozent
    • Kann seine Stunden in der kommenden Woche sehen.
    • Kann den Inhalt seiner Kurse für jede Unterrichtseinheit (UE) pflegen.
    • Kann die Schüler eines Kurses sehen.
  • Die Verwaltung
    • Kann sehen, welcher Dozent welchen Kurs leitet.
    • Kann sehen, welcher Schüler an welchem Kurs teilnimmt.
    • Kann sehen, welche Schüler von einem gegebenen Dozent unterrichtet werden.
    • Kann Räume anlegen.
    • Kann bearbeiten, welche Instrumente in einem Raum zur Verfügung stehen.
    • Kann die aktuelle Verfügbarkeit und die nächsten Termine eines Raumes sehen.
    • Kann offene Anträge sehen.
    • Kann aus eingehenden Anträgen neue Kurse erstellen und UE planen.
    • Kann in einer Übersicht die Einnahmen der Musikschule und den Betrag, welcher an jeden Dozent gezahlt wird, sehen.
  • Der Administrative Nutzer
    • Konfiguriert die Betriebsparameter des Systems.
    • Sichert die Datenbank.
  • Der Schüler
    • Kann einen Aufnahmeantrag über ein Webformular abschicken
    • Erhält, nachdem die Verwaltung einen Kurs aus dem Antrag erstellt hat, eine Bestätigung (Kursbestätigung) mit den Zeiten seiner Unterrichtseinheiten.
    • Hat bis zum ersten Unterrichtstermin Zeit, um den Unterricht zu bestätigen.
  • Sonstiges
    • Deutsch ist Verkehrssprache.
    • Alle Funktionen sind über das Internet erreichbar.
    • Die Anwendung ist für Mobilgeräte optimiert.

Wunschkriterien

  • Der Administrative Nutzer
    • Möchte bei der Erstellung eines Kurses durch einen Vorschlag zu passendem Raum, Dozenten und Zeitpunkt unterstützt werden.
  • Der Schüler
    • Möchte sich einloggen können um die eigenen Unterrichtszeiten und Inhalte einzusehen.
  • Sonstiges
    • Daten sollen soweit sinnvoll möglich auf dem Endgerät zwischengespeichert werden, damit auch ohne Internetverbindung grundlegende Funktionalität geleistet werden kann.

Abgrenzungungskriterien

  • Das PIP
    • Soll keine Abrechnung erstellen oder verschicken.

Produktübersicht

  • Das System wird von den Rollen Verwaltung, Dozent und Anonym bedient.
  • Die Rollen Verwaltung und Dozent werden über einen Login authentizifiert, ihnen stehen abhängig von ihrer Rolle verschiedene Funktionen zur verfügung, diese werden unter Produktfunktionen spezifiziert. Sonstige Funktionen stehen allen Rollen zur verfügung.

Produktdaten

  • Datenstrukturen der Anwendung: ERD
  • Aus einem Antrag wird ein Schüler, eine von Person erbende Klasse, erstellt, welche alle personenbezogene Daten erhält. (siehe Diagramm)
  • Außerdem werden Angaben zu der Auswahl des Antragstellers zu Instrument und Unterrichtstyp gespeichert.
  • Einem Kurs wird stehts ein Schüler zugewiesen, es sei denn es handelt sich um einen Kurs mit Typ "Band". In diesem Fall können beliebig viele Schüler zugewiesen werden.
  • Ein Kurs hat Unterrichtseinheiten. Diese Stellen einzelne eindeutige Zeitpunkte dar, an welchen der Kurs unterrichtet wird/wurde.
    • Es wird der Startzeitpunkt gespeichert, "Wed Jun 12 2019 12:15:00 GMT+0200 (Central European Summer Time)" stellt die Unterrichtseinheit von 12:15 bis 12:30 dar.
    • Für jede Unterrichtseinheit kann der Dozent den Inhalt pflegen, um die Unterrichtsinhalte zu Dokumentieren.

Speichernutzung

  • Ein Personendatensatz kann bis zu 5KB groß sein, typisch ~300 Byte.
  • Ein Kursdatensatzen kann bis zu 55 Byte groß sein.
  • Ein Unterrichtseinheitendatensatz kann bis zu 2056 Byte groß sein.

Produktleistungen

Benutzeroberfläche /L01/

  • Die Anwendung bietet eine deutschsprachige Benutzeroberfläche

Datenschutz /L02/

  • Daten werden in einer passwordgeschützten Datenbank abgelegt

Loggin und Nachvollziehbarkeit /L03/

  • Zugriffe wie das Schreiben von Daten (anlegen und modifizieren von Datensätzen) werden in einem Log dokumentiert und können so nachvollzogen werden.

Produkteinsatz

Anwendungsbereiche

Die Anwendung wird von den Dozenten und der Verwaltung zur Planung und Organisation der Musikschule genutzt.

Zielgruppe

Die Zielgruppe besteht aus der Verwaltung und allen aktuellen und zukünftigen Dozenten der Musikschule. Eventeuell wird die Zielgruppe um die Schüler der Musikschule erweitert.

Betriebsbedingungen

  • Betriebsdauer: täglich, 24 Stunden
  • Die Anwendung und ihre Teile werden auf einem virtuellen privaten Server bei einem externen Anbieter bereitgestellt
  • Die Anwendung ist global über das Internet erreichbar
  • Der Betrieb wird vom Auftragnehmer überwacht

Produktumgebung

Software

  • Client
    • Chrome oder Chromium basierter Browser der Version 74, Firefox 67
  • Server
    • Docker unter Linux (Version 18.09.5)

Hardware

  • Client
    • Internetfähiges Endgerät
  • Server
    • Internetfähiger Server
    • Ausreichende Rechen- und Festplattenkapazität

Entwicklungsumgebung

Software

Backend

  • Entwickler nutzen die IDE Visual Studio 2019 von Microsoft
  • Zum Untersuchen der Datenbank wird ein DB Browser genutzt
  • Code wird mithilfe des .NET Komplierers kompiliert
  • Als Betriebssystem wird Microsoft Windows genutzt
  • Als Codeverwaltung wird Gitlab CE genutzt
  • Als CI/CD Tool wird Gitlab CI/CD genutzt

Frontend

  • Entwickler nutzen den Code Editor Visual Studio Code von Microsoft
  • Codequality Kontrolle wird von dem Codelinter "ESLint" unterstützt
  • Node JS
  • Verschiedene Node JS Tools werden zur Unterstützung genutzt (z.B. nodemon)
  • Als Betriebssystem wird Microsoft Windows oder Ubuntu 19.04 genutzt
  • Als Codeverwaltung wird Gitlab CE genutzt
  • Als CI/CD Tool wird Gitlab CI/CD genutzt

Hardware

Backend und Frontend

  • Computer mit einem amd64 Mehrkernprozessor, mind. 8 GB RAM und mind. 1 GB freiem Festspeicher

Orgware

Backend und Frontend

  • Das Team nutzt Slack zur Kommunikation
  • Als Codeverwaltung wird Gitlab CE genutzt
  • Als CI/CD Tool wird Gitlab CI/CD genutzt

Produktfunktionen

Annahmen und Definitionen zu Produktfunktionen

Getroffene Annahmen und Definitionen zu unterliegenen Produktfunktionen und Geschäftsprozessen, mit denen die Nutzer nicht direkt in Kontakt kommen und daher nicht einer speziellen Funktion zugeordnet werden können.

  • Aus einem eingegangenen Antrag wird von der Verwaltung mithilfe der gebotenen Funktion ein Kurs erstellt. Hierfür wählt diese einen passenden Dozenten, Raum, und UEs aus. Diese werden dem Antragsteller auf geeignetem Weg, zusammen mit einem ausgefertigtem Vertrag, zustellt. Der Antragsteller hat bis zum ersten Unterrichtszeitpunkt Zeit, um diesen Vertrag unterschrieben vorzulegen. Ansonsten verfällt der Kurs und Dozent und Raum werden zu den Zeitpunkten der geplanten UEs freigegeben.
  • Im Falle eines "Band"-Kurses wird dem Antragsteller zusammen mit dem Vertrag ein einzigartiger Link zugestellt. Über diesen Link können sich weitere Mitglieder durch angeben ihrer personenbezogenen Daten zu diesem bereits erstellten Kurs anmelden. Die Anmeldung ist bis zum ersten Unterrichtszeitpunkt möglich.
  • Die Laufzeit des Vertrags startet zum ersten Unterrichtstermin.
  • Unterrichtszeiten werden in 15min (1/4 Stunden) Blöcken gegeben und geplant.

Dozentenfunktionen

Wochenübersicht /FD01/

  • Der Nutzer sieht eine Übersicht mit von ihm gegebenen Kursen in den kommenden 7 Tagen, gruppiert nach Wochentag
  • Mit einem Klick auf einen Kurs gelangt man zu den entsprechenden Kursdetails

Kursdetails /FD02/

  • Der Nutzer sieht Details zu einem Kurs
  • Er sieht alle Schüler, welche an dem Kurs teilnehmen
  • Er sieht die Einträge zu den den Unterrichtsinhalten der vergangen Unterrichtseinheiten und kann den Inhalt des letzten Termins bearbeiten / erfassen.

Verwaltungsfunktionen

Offene Anträge /FV01/

  • Es werden alle neu eingegangenen und nicht bestägtigten Anträge angzeigt.
  • Mit einem Klick auf einen eingegangen Antrag wird die Kurs erstellen Seite aufgerufen.

Kurs Erstellen /FV02/

  • Nach einem eingegegangen Antrag kann basierent auf diesem ein Kurs erstellt werden.
  • Typ (Einzel, Gruppe, ), Instrument(e), Laufzeit und Personenbezogne Daten werden in der Kurserstllungs Mask vorausgefüllt
  • Es werden Dozenten angezeigt, welche zu den Instrumentenanforderungen passen
  • Es werden Räume angezeigt, welche zu den Instrumentenanforderungen passen
  • Nach Auswahl von Raum und Dozent wird/werden die Zeit(en) für die Unterrichtseinheiten gewählt werden; Die Möglichkeit der auswahl wird überprüft
  • Nach erfolgreicher Auswahl wird der Kurs in der Datenbank angelegt und der Schüler über den Kurs informiert. Dieser muss ihn vor der ersten Unterrichtseinheit bestätigen, ansonster verfällt der Kurs.

Kursübersicht /FV03/

  • In der Kursübersicht werden in Tabellenform alle Kurse zusammen mit ihren Dozenten angezeigt.
  • Die Tabelle kann spaltenweise sortiert und nach Dozenten- und Kursname gefiltert werden.
  • Ein Klick auf einen Kurs führt zu Kursdetails.
  • Ein Klick auf einen Dozenten führt zu Schüler eines Dozenten

Schülerübersicht /FV04/

  • Es werden in Tabellenform alle Schüler mit ihren Kursen angezeigt; ein Kurs pro Zeile
    • Ein Schüler kann also mehrere Zeilen umfassen.
  • Die Tabelle kann spaltenweise sortiert und nach Schüler- und Kursname gefiltert werden.

Schüler eines Dozenten /FV05/

  • Es werden alle Schüler des ausgewählten Dozenten angezeigt.

Raumübersicht /FV06/

  • Es werden alle Räume mit Grundlegenden Informationen angezeigt.
    • Aktuelle Belegung
    • Instrumente
  • Es wird ein Button zum erstellen von neuen Räumen angezeigt

Raumdetails /FV07/

  • Es werden alle Informationen zu einem Raum Angzeigt.
    • Name (bearbeitbar)
    • Aktuelle Belegung
    • Instrumente (bearbeitbar)
    • Nächste 5 Unterrichtseinheiten in diesem Raum

Finanzübersicht /FV09/

  • Es werden die gesamten monatlichen Einnahmen der Musikschule angzeigt.
  • Es werden die Zahlungen an die Dozenten, aufgeschlüsselt nach Dozent angezeigt.

Sonstige Funktionen

Login /F01/

  • Ein Nutzer kann sich mit Benutzername und Passwort anmelden.
  • Benutzername und Passwort können von dem Administrativen Nutzer mithilfe von Direktzugriff auf das System angelegt werden.

Mitglied zu Kurs hinzufügen /F02/

  • Wenn ein Schüler einen Gruppenkurs ("Band"-Kurs) erstellt hat, erhält dieser mit seiner Kursbestätigung einen Einladungslink, welcher auf eine "Antrag-Lite" Seite führt.
    • Hier können sich weitere Mitglieder der Gruppe/Band in diesen Kurs eintragen.
    • Dafür müssen diese nur Ihre personenbezogenen Daten angeben; Sie werden in der über den Link identifizierten Kurs eingeschrieben.
    • Dies muss vor dem ersten Unterrichtstermin geschehen.

Antrag Stellen /F03/

  • Der Nutzer gibt personenbezogene- und kursbezogenen Daten an. Aus diesen wird beim Absenden ein Antrag in der Datenbank erstellt, welche von der Verwaltung mithilfe der Funktion Offene Anträge eingesehen und weiter verarbeitet werden können.
  • Personenbezogene Daten:
    • Vorname
    • Nachname
    • Geburtsdatum
    • Geburtsort
    • PLZ
    • Ort
    • Straße
    • Hausnummer
    • Telefon
    • EMail
    • BLZ
    • Bankname
    • Kontonummer
  • Kursbezogene Daten:
    • Instrumente
    • Laufzeit
    • Unterrichtstyp

Benutzeroberfläche

Was sind die grundlegenden Anforderungen an die Benutzeroberfläche (Bildschirmlayout, Dialogstruktur, ...)?

Dialogstruktur

Im Folgenden wird die grobe Dialogstruktur einer fehlerfreien bzw. konfliktfreien Benutzung des Systems gezeigt. Fehleingaben haben eine akkumulierte Fehlermeldung zur Folge.

Startseite

Hauptseite

Übersichtsseite Dozenten

Die Übersichtsseite Dozenten ist die Startseite des Dozenten, die der Dozent nach der Anmeldung /F01/ erreicht.

Hauptseite

Übersichtsseite Verwaltung

Die Übersichtsseite Verwaltung ist die Startseite der Verwaltung, die die Verwaltung nach der Anmeldung /F01/ erreicht.

Hauptseite

Bildschirmlayout

Das Frontend wird mithilfe der JavaScript Bibliothek React erstellt und das Design wird mithilfe der MIT-lizensierten Designbibliothek Material-UI realisiert. Die Anwendung ist für Mobilegeräte optimiert und wird nach den Prinzipien des responsiven Designs entwickelt.

Ausnahme sind die Administrationsfunktionen

Testfälle

  1. Der Login funktioniert und erlaubt nur Zugriff auf autorisierte Bereiche und Ansichten.
  2. Anonyme Nutzer können Anträge stellen, diese gehen in der Datenbank ein.
  3. Die Verwaltung kann Anträge verarbeiten und daraus Kurse erstellen.
  • Der Antragsteller wird über die Verarbeitung informiert.
  1. Die Übersichtsseiten zeigen korrekte Informationen an.