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.
843 lines
28 KiB
843 lines
28 KiB
<!DOCTYPE html> |
|
<html> |
|
<head> |
|
<title>Pflichtenheft.md</title> |
|
<meta http-equiv="Content-type" content="text/html;charset=UTF-8"> |
|
|
|
<style> |
|
/*--------------------------------------------------------------------------------------------- |
|
* Copyright (c) Microsoft Corporation. All rights reserved. |
|
* Licensed under the MIT License. See License.txt in the project root for license information. |
|
*--------------------------------------------------------------------------------------------*/ |
|
|
|
body { |
|
font-family: "Segoe WPC", "Segoe UI", "SFUIText-Light", "HelveticaNeue-Light", sans-serif, "Droid Sans Fallback"; |
|
font-size: 14px; |
|
padding: 0 12px; |
|
line-height: 22px; |
|
word-wrap: break-word; |
|
} |
|
|
|
#code-csp-warning { |
|
position: fixed; |
|
top: 0; |
|
right: 0; |
|
color: white; |
|
margin: 16px; |
|
text-align: center; |
|
font-size: 12px; |
|
font-family: sans-serif; |
|
background-color:#444444; |
|
cursor: pointer; |
|
padding: 6px; |
|
box-shadow: 1px 1px 1px rgba(0,0,0,.25); |
|
} |
|
|
|
#code-csp-warning:hover { |
|
text-decoration: none; |
|
background-color:#007acc; |
|
box-shadow: 2px 2px 2px rgba(0,0,0,.25); |
|
} |
|
|
|
|
|
body.scrollBeyondLastLine { |
|
margin-bottom: calc(100vh - 22px); |
|
} |
|
|
|
body.showEditorSelection .code-line { |
|
position: relative; |
|
} |
|
|
|
body.showEditorSelection .code-active-line:before, |
|
body.showEditorSelection .code-line:hover:before { |
|
content: ""; |
|
display: block; |
|
position: absolute; |
|
top: 0; |
|
left: -12px; |
|
height: 100%; |
|
} |
|
|
|
body.showEditorSelection li.code-active-line:before, |
|
body.showEditorSelection li.code-line:hover:before { |
|
left: -30px; |
|
} |
|
|
|
.vscode-light.showEditorSelection .code-active-line:before { |
|
border-left: 3px solid rgba(0, 0, 0, 0.15); |
|
} |
|
|
|
.vscode-light.showEditorSelection .code-line:hover:before { |
|
border-left: 3px solid rgba(0, 0, 0, 0.40); |
|
} |
|
|
|
.vscode-dark.showEditorSelection .code-active-line:before { |
|
border-left: 3px solid rgba(255, 255, 255, 0.4); |
|
} |
|
|
|
.vscode-dark.showEditorSelection .code-line:hover:before { |
|
border-left: 3px solid rgba(255, 255, 255, 0.60); |
|
} |
|
|
|
.vscode-high-contrast.showEditorSelection .code-active-line:before { |
|
border-left: 3px solid rgba(255, 160, 0, 0.7); |
|
} |
|
|
|
.vscode-high-contrast.showEditorSelection .code-line:hover:before { |
|
border-left: 3px solid rgba(255, 160, 0, 1); |
|
} |
|
|
|
img { |
|
max-width: 100%; |
|
max-height: 100%; |
|
} |
|
|
|
a { |
|
color: #4080D0; |
|
text-decoration: none; |
|
} |
|
|
|
a:focus, |
|
input:focus, |
|
select:focus, |
|
textarea:focus { |
|
outline: 1px solid -webkit-focus-ring-color; |
|
outline-offset: -1px; |
|
} |
|
|
|
hr { |
|
border: 0; |
|
height: 2px; |
|
border-bottom: 2px solid; |
|
} |
|
|
|
h1 { |
|
padding-bottom: 0.3em; |
|
line-height: 1.2; |
|
border-bottom-width: 1px; |
|
border-bottom-style: solid; |
|
} |
|
|
|
h1, h2, h3 { |
|
font-weight: normal; |
|
} |
|
|
|
h1 code, |
|
h2 code, |
|
h3 code, |
|
h4 code, |
|
h5 code, |
|
h6 code { |
|
font-size: inherit; |
|
line-height: auto; |
|
} |
|
|
|
a:hover { |
|
color: #4080D0; |
|
text-decoration: underline; |
|
} |
|
|
|
table { |
|
border-collapse: collapse; |
|
} |
|
|
|
table > thead > tr > th { |
|
text-align: left; |
|
border-bottom: 1px solid; |
|
} |
|
|
|
table > thead > tr > th, |
|
table > thead > tr > td, |
|
table > tbody > tr > th, |
|
table > tbody > tr > td { |
|
padding: 5px 10px; |
|
} |
|
|
|
table > tbody > tr + tr > td { |
|
border-top: 1px solid; |
|
} |
|
|
|
blockquote { |
|
margin: 0 7px 0 5px; |
|
padding: 0 16px 0 10px; |
|
border-left: 5px solid; |
|
} |
|
|
|
code { |
|
font-family: Menlo, Monaco, Consolas, "Droid Sans Mono", "Courier New", monospace, "Droid Sans Fallback"; |
|
font-size: 14px; |
|
line-height: 19px; |
|
} |
|
|
|
body.wordWrap pre { |
|
white-space: pre-wrap; |
|
} |
|
|
|
.mac code { |
|
font-size: 12px; |
|
line-height: 18px; |
|
} |
|
|
|
pre:not(.hljs), |
|
pre.hljs code > div { |
|
padding: 16px; |
|
border-radius: 3px; |
|
overflow: auto; |
|
} |
|
|
|
/** Theming */ |
|
|
|
.vscode-light, |
|
.vscode-light pre code { |
|
color: rgb(30, 30, 30); |
|
} |
|
|
|
.vscode-dark, |
|
.vscode-dark pre code { |
|
color: #DDD; |
|
} |
|
|
|
.vscode-high-contrast, |
|
.vscode-high-contrast pre code { |
|
color: white; |
|
} |
|
|
|
.vscode-light code { |
|
color: #A31515; |
|
} |
|
|
|
.vscode-dark code { |
|
color: #D7BA7D; |
|
} |
|
|
|
.vscode-light pre:not(.hljs), |
|
.vscode-light code > div { |
|
background-color: rgba(220, 220, 220, 0.4); |
|
} |
|
|
|
.vscode-dark pre:not(.hljs), |
|
.vscode-dark code > div { |
|
background-color: rgba(10, 10, 10, 0.4); |
|
} |
|
|
|
.vscode-high-contrast pre:not(.hljs), |
|
.vscode-high-contrast code > div { |
|
background-color: rgb(0, 0, 0); |
|
} |
|
|
|
.vscode-high-contrast h1 { |
|
border-color: rgb(0, 0, 0); |
|
} |
|
|
|
.vscode-light table > thead > tr > th { |
|
border-color: rgba(0, 0, 0, 0.69); |
|
} |
|
|
|
.vscode-dark table > thead > tr > th { |
|
border-color: rgba(255, 255, 255, 0.69); |
|
} |
|
|
|
.vscode-light h1, |
|
.vscode-light hr, |
|
.vscode-light table > tbody > tr + tr > td { |
|
border-color: rgba(0, 0, 0, 0.18); |
|
} |
|
|
|
.vscode-dark h1, |
|
.vscode-dark hr, |
|
.vscode-dark table > tbody > tr + tr > td { |
|
border-color: rgba(255, 255, 255, 0.18); |
|
} |
|
|
|
.vscode-light blockquote, |
|
.vscode-dark blockquote { |
|
background: rgba(127, 127, 127, 0.1); |
|
border-color: rgba(0, 122, 204, 0.5); |
|
} |
|
|
|
.vscode-high-contrast blockquote { |
|
background: transparent; |
|
border-color: #fff; |
|
} |
|
</style> |
|
|
|
<style> |
|
/* Tomorrow Theme */ |
|
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */ |
|
/* Original theme - https://github.com/chriskempson/tomorrow-theme */ |
|
|
|
/* Tomorrow Comment */ |
|
.hljs-comment, |
|
.hljs-quote { |
|
color: #8e908c; |
|
} |
|
|
|
/* Tomorrow Red */ |
|
.hljs-variable, |
|
.hljs-template-variable, |
|
.hljs-tag, |
|
.hljs-name, |
|
.hljs-selector-id, |
|
.hljs-selector-class, |
|
.hljs-regexp, |
|
.hljs-deletion { |
|
color: #c82829; |
|
} |
|
|
|
/* Tomorrow Orange */ |
|
.hljs-number, |
|
.hljs-built_in, |
|
.hljs-builtin-name, |
|
.hljs-literal, |
|
.hljs-type, |
|
.hljs-params, |
|
.hljs-meta, |
|
.hljs-link { |
|
color: #f5871f; |
|
} |
|
|
|
/* Tomorrow Yellow */ |
|
.hljs-attribute { |
|
color: #eab700; |
|
} |
|
|
|
/* Tomorrow Green */ |
|
.hljs-string, |
|
.hljs-symbol, |
|
.hljs-bullet, |
|
.hljs-addition { |
|
color: #718c00; |
|
} |
|
|
|
/* Tomorrow Blue */ |
|
.hljs-title, |
|
.hljs-section { |
|
color: #4271ae; |
|
} |
|
|
|
/* Tomorrow Purple */ |
|
.hljs-keyword, |
|
.hljs-selector-tag { |
|
color: #8959a8; |
|
} |
|
|
|
.hljs { |
|
display: block; |
|
overflow-x: auto; |
|
color: #4d4d4c; |
|
padding: 0.5em; |
|
} |
|
|
|
.hljs-emphasis { |
|
font-style: italic; |
|
} |
|
|
|
.hljs-strong { |
|
font-weight: bold; |
|
} |
|
</style> |
|
|
|
<style> |
|
/* |
|
* Markdown PDF CSS |
|
*/ |
|
|
|
body { |
|
font-family: "Meiryo", "Segoe WPC", "Segoe UI", "SFUIText-Light", "HelveticaNeue-Light", sans-serif, "Droid Sans Fallback"; |
|
} |
|
|
|
pre { |
|
background-color: #f8f8f8; |
|
border: 1px solid #cccccc; |
|
border-radius: 3px; |
|
overflow-x: auto; |
|
white-space: pre-wrap; |
|
overflow-wrap: break-word; |
|
} |
|
|
|
pre:not(.hljs) { |
|
padding: 23px; |
|
line-height: 19px; |
|
} |
|
|
|
blockquote { |
|
background: rgba(127, 127, 127, 0.1); |
|
border-color: rgba(0, 122, 204, 0.5); |
|
} |
|
|
|
.emoji { |
|
height: 1.4em; |
|
} |
|
|
|
/* for inline code */ |
|
:not(pre):not(.hljs) > code { |
|
color: #C9AE75; /* Change the old color so it seems less like an error */ |
|
font-size: inherit; |
|
} |
|
|
|
/* Page Break : use <div class="page"/> to insert page break |
|
-------------------------------------------------------- */ |
|
.page { |
|
page-break-after: always; |
|
} |
|
|
|
</style> |
|
|
|
</head> |
|
<body> |
|
<h1 id="pflichtenheft">Pflichtenheft</h1> |
|
<h2 id="inhalt">Inhalt</h2> |
|
<ul> |
|
<li><a href="#pflichtenheft">Pflichtenheft</a> |
|
<ul> |
|
<li><a href="#inhalt">Inhalt</a></li> |
|
<li><a href="#zielbestimmungsss">Zielbestimmungsss</a> |
|
<ul> |
|
<li><a href="#musskriterien">Musskriterien</a></li> |
|
<li><a href="#wunschkriterien">Wunschkriterien</a></li> |
|
<li><a href="#abgrenzungungskriterien">Abgrenzungungskriterien</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#produkt%C3%BCbersicht">Produktübersicht</a></li> |
|
<li><a href="#produktdaten">Produktdaten</a> |
|
<ul> |
|
<li><a href="#speichernutzung">Speichernutzung</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#produktleistungen">Produktleistungen</a> |
|
<ul> |
|
<li><a href="#benutzeroberfl%C3%A4che-l01">Benutzeroberfläche <strong>/L01/</strong></a></li> |
|
<li><a href="#datenschutz-l02">Datenschutz <strong>/L02/</strong></a></li> |
|
<li><a href="#loggin-und-nachvollziehbarkeit-l03">Loggin und Nachvollziehbarkeit <strong>/L03/</strong></a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#produkteinsatz">Produkteinsatz</a> |
|
<ul> |
|
<li><a href="#anwendungsbereiche">Anwendungsbereiche</a></li> |
|
<li><a href="#zielgruppe">Zielgruppe</a></li> |
|
<li><a href="#betriebsbedingungen">Betriebsbedingungen</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#produktumgebung">Produktumgebung</a> |
|
<ul> |
|
<li><a href="#software">Software</a></li> |
|
<li><a href="#hardware">Hardware</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#entwicklungsumgebung">Entwicklungsumgebung</a> |
|
<ul> |
|
<li><a href="#software-1">Software</a> |
|
<ul> |
|
<li><a href="#backend">Backend</a></li> |
|
<li><a href="#frontend">Frontend</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#hardware-1">Hardware</a> |
|
<ul> |
|
<li><a href="#backend-und-frontend">Backend und Frontend</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#orgware">Orgware</a> |
|
<ul> |
|
<li><a href="#backend-und-frontend-1">Backend und Frontend</a></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
<li><a href="#produktfunktionen">Produktfunktionen</a> |
|
<ul> |
|
<li><a href="#annahmen-und-definitionen-zu-produktfunktionen">Annahmen und Definitionen zu Produktfunktionen</a></li> |
|
<li><a href="#dozentenfunktionen">Dozentenfunktionen</a> |
|
<ul> |
|
<li><a href="#wochen%C3%BCbersicht-fd01">Wochenübersicht <strong>/FD01/</strong></a></li> |
|
<li><a href="#kursdetails-fd02">Kursdetails <strong>/FD02/</strong></a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#verwaltungsfunktionen">Verwaltungsfunktionen</a> |
|
<ul> |
|
<li><a href="#offene-antr%C3%A4ge-fv01">Offene Anträge <strong>/FV01/</strong></a></li> |
|
<li><a href="#kurs-erstellen-fv02">Kurs Erstellen <strong>/FV02/</strong></a></li> |
|
<li><a href="#kurs%C3%BCbersicht-fv03">Kursübersicht <strong>/FV03/</strong></a></li> |
|
<li><a href="#sch%C3%BCler%C3%BCbersicht-fv04">Schülerübersicht <strong>/FV04/</strong></a></li> |
|
<li><a href="#sch%C3%BCler-eines-dozenten-fv05">Schüler eines Dozenten <strong>/FV05/</strong></a></li> |
|
<li><a href="#raum%C3%BCbersicht-fv06">Raumübersicht <strong>/FV06/</strong></a></li> |
|
<li><a href="#raumdetails-fv07">Raumdetails <strong>/FV07/</strong></a></li> |
|
<li><a href="#finanz%C3%BCbersicht-fv09">Finanzübersicht <strong>/FV09/</strong></a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#sonstige-funktionen">Sonstige Funktionen</a> |
|
<ul> |
|
<li><a href="#login-f01">Login <strong>/F01/</strong></a></li> |
|
<li><a href="#mitglied-zu-kurs-hinzuf%C3%BCgen-f02">Mitglied zu Kurs hinzufügen <strong>/F02/</strong></a></li> |
|
<li><a href="#antrag-stellen-f03">Antrag Stellen <strong>/F03/</strong></a></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
<li><a href="#benutzeroberfl%C3%A4che">Benutzeroberfläche</a> |
|
<ul> |
|
<li><a href="#dialogstruktur">Dialogstruktur</a> |
|
<ul> |
|
<li><a href="#startseite">Startseite</a></li> |
|
<li><a href="#%C3%BCbersichtsseite-dozenten">Übersichtsseite Dozenten</a></li> |
|
<li><a href="#%C3%BCbersichtsseite-verwaltung">Übersichtsseite Verwaltung</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#bildschirmlayout">Bildschirmlayout</a></li> |
|
</ul> |
|
</li> |
|
<li><a href="#testf%C3%A4lle">Testfälle</a></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h2 id="zielbestimmungsss">Zielbestimmungsss</h2> |
|
<blockquote> |
|
<p>Das Ziel von Parsec Iron Puffin (<em>PIP</em>) 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.</p> |
|
</blockquote> |
|
<p>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.</p> |
|
<p>Der Dozent erhält eine Übersicht über die Stunden, welche er in der Woch 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.</p> |
|
<p>Nutzer können mithilfe der Anwendung Kurse beantragen und "Band"-Kursen beitreten.</p> |
|
<h3 id="musskriterien">Musskriterien</h3> |
|
<ul> |
|
<li>Es besteht ein Authentifizierung um den Zugriff auf alle Funktionen auf die jeweils berechtigten Personen zu beschränken.</li> |
|
<li>Der Dozent |
|
<ul> |
|
<li>Kann seine Stunden in der kommenden Woche sehen können.</li> |
|
<li>Kann den Inhalt seiner Kurs für jede Unterrichtseinheit (<em>UE</em>) pflegen.</li> |
|
<li>Kann die Schüler eines Kurses sehen.</li> |
|
</ul> |
|
</li> |
|
<li>Die Verwaltung |
|
<ul> |
|
<li>Kann sehen, welcher Lehrer welchen Kurs leitet.</li> |
|
<li>Kann sehen, welcher Schüler an welchem Kurs teilnimmt.</li> |
|
<li>Kann sehen, welche Schüler von einem gegebenen Lehrer unterrichtet werden.</li> |
|
<li>Kann Räume anlegen.</li> |
|
<li>Kann bearbeiten, welche Instrumente in einem Raum zu verfügung stehen.</li> |
|
<li>Kann die aktuelle Verfügbarkeit und die nächsten Termine eines Raumes sehen.</li> |
|
<li>Kann offene Anträge sehen.</li> |
|
<li>Kann aus eingehenden Anträgen neue Kurs erstellen und UE planen.</li> |
|
<li>Kann in einer Übersicht die Einnahmen der Musikschule und den Betrag, welcher an jeden Dozent gezahlt wird sehen.</li> |
|
</ul> |
|
</li> |
|
<li>Der Administrative Nutzer |
|
<ul> |
|
<li>Konfiguriert die Betriebsparameter des Systems</li> |
|
<li>Sichert die Datenbank</li> |
|
</ul> |
|
</li> |
|
<li>Der Schüler |
|
<ul> |
|
<li>kann einen Aufnahmeantrag über ein Webformular abschicken</li> |
|
<li>erhält, nachdem die Verwaltung einen Kurs aus dem Antrag erstellt hat, eine Bestätigung (Kursbestätigung) mit den Zeiten Seiner Unterrichtseinheiten</li> |
|
<li>hat bis zum ersten Unterrichtstermin Zeit, um den Unterricht zu bestätigen</li> |
|
</ul> |
|
</li> |
|
<li>Sonstiges |
|
<ul> |
|
<li>Deutsch ist Verkehrssprache</li> |
|
<li>Alle Funktionen sind über das Internet erreichbar</li> |
|
<li>Die Anwendung ist für Mobilgeräte optimiert</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h3 id="wunschkriterien">Wunschkriterien</h3> |
|
<ul> |
|
<li>Der Administrative Nutzer |
|
<ul> |
|
<li>Möchte bei der Erstellung eines Kurses durch einen Vorschlag zu passendem Raum, Dozenten und Zeitpunkt unterstützt werden.</li> |
|
</ul> |
|
</li> |
|
<li>Der Schüler |
|
<ul> |
|
<li>Möchte sich einloggen können um die eigenen Unterrichtszeiten und Inhalte einzusehen</li> |
|
</ul> |
|
</li> |
|
<li>Sonstiges |
|
<ul> |
|
<li>Daten sollen soweit sinnvoll möglich auf dem Endgerät zwischengespeichert werden, damit auch ohne Internetverbindung Grundlegende funktionalität geleistet werden kann.</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h3 id="abgrenzungungskriterien">Abgrenzungungskriterien</h3> |
|
<ul> |
|
<li>Das <em>PIP</em> |
|
<ul> |
|
<li>soll keine Abrechnung erstellen oder verschicken.</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h2 id="produkt%C3%BCbersicht">Produktübersicht</h2> |
|
<ul> |
|
<li>Das System wird von den Rollen Verwaltung, Dozent und Anonym bedient.</li> |
|
<li>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 <a href="#produktfunktionen">Produktfunktionen</a> spezifiziert. Sonstige Funktionen stehen <em>allen</em> Rollen zur verfügung.</li> |
|
</ul> |
|
<h2 id="produktdaten">Produktdaten</h2> |
|
<ul> |
|
<li>Datenstrukturen der Anwendung: |
|
<img src="EVA ERD Umletino.png" alt="ERD"></li> |
|
<li>Aus einem Antrag wird ein <em>Schüler</em>, eine von <em>Person</em> erbende Klasse, erstellt, welche alle personenbezogene Daten erhält. (siehe Diagramm)</li> |
|
<li>Außerdem werden Angaben zu der Auswahl des Antragstellers zu <em>Instrument</em> und <em>Unterrichtstyp</em> gespeichert.</li> |
|
<li>Einem <em>Kurs</em> wird stehts ein <em>Schüler</em> zugewiesen, es sei denn es handelt sich um einen Kurs mit Typ "Band". In diesem Fall können beliebig viele <em>Schüler</em> zugewiesen werden.</li> |
|
<li>Ein <em>Kurs</em> hat <em>Unterrichtseinheiten</em>. Diese Stellen einzelne eindeutige Zeitpunkte dar, an welchen der <em>Kurs</em> unterrichtet wird/wurde. |
|
<ul> |
|
<li>Es wird der Startzeitpunkt gespeichert, "Wed Jun 12 2019 12:15:00 GMT+0200 (Central European Summer Time)" stellt die <em>Unterrichtseinheit</em> von 12:15 bis 12:30 dar.</li> |
|
<li>Für jede Unterrichtseinheit kann der Dozent den Inhalt pflegen, um die Unterrichtsinhalte zu Dokumentieren.</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h3 id="speichernutzung">Speichernutzung</h3> |
|
<ul> |
|
<li>Ein Personendatensatz kann bis zu 5KB groß sein, typisch ~300 Byte.</li> |
|
<li>Ein Kursdatensatzen kann bis zu 55 Byte groß sein.</li> |
|
<li>Ein Unterrichtseinheitendatensatz kann bis zu 2056 Byte groß sein.</li> |
|
</ul> |
|
<h2 id="produktleistungen">Produktleistungen</h2> |
|
<h3 id="benutzeroberfl%C3%A4che-l01">Benutzeroberfläche <strong>/L01/</strong></h3> |
|
<ul> |
|
<li>Die Anwendung bietet eine deutschsprachige Benutzeroberfläche</li> |
|
</ul> |
|
<h3 id="datenschutz-l02">Datenschutz <strong>/L02/</strong></h3> |
|
<ul> |
|
<li>Daten werden in einer passwordgeschützten Datenbank abgelegt</li> |
|
</ul> |
|
<h3 id="loggin-und-nachvollziehbarkeit-l03">Loggin und Nachvollziehbarkeit <strong>/L03/</strong></h3> |
|
<ul> |
|
<li>Zugriffe wie das Schreiben von Daten (anlegen und modifizieren von Datensätzen) werden in einem Log dokumentiert und können so nachvollzogen werden.</li> |
|
</ul> |
|
<h2 id="produkteinsatz">Produkteinsatz</h2> |
|
<h3 id="anwendungsbereiche">Anwendungsbereiche</h3> |
|
<p>Die Anwendung wird von den Dozenten und der Verwaltung zur Planung und Organisation der Musikschule genutzt.</p> |
|
<h3 id="zielgruppe">Zielgruppe</h3> |
|
<p>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.</p> |
|
<h3 id="betriebsbedingungen">Betriebsbedingungen</h3> |
|
<ul> |
|
<li>Betriebsdauer: täglich, 24 Stunden</li> |
|
<li>Die Anwendung und ihre Teile werden auf einem virtuellen privaten Server bei einem externen Anbieter bereitgestellt</li> |
|
<li>Die Anwendung ist global über das Internet erreichbar</li> |
|
<li>Der Betrieb wird vom Auftragnehmer überwacht</li> |
|
</ul> |
|
<h2 id="produktumgebung">Produktumgebung</h2> |
|
<h3 id="software">Software</h3> |
|
<ul> |
|
<li>Client |
|
<ul> |
|
<li>Chrome oder Chromium basierter Browser der Version 74, Firefox 67</li> |
|
</ul> |
|
</li> |
|
<li>Server |
|
<ul> |
|
<li>Docker unter Linux (Version 18.09.5)</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h3 id="hardware">Hardware</h3> |
|
<ul> |
|
<li>Client |
|
<ul> |
|
<li>Internetfähiges Endgerät</li> |
|
</ul> |
|
</li> |
|
<li>Server |
|
<ul> |
|
<li>Internetfähiger Server</li> |
|
<li>Ausreichende Rechen- und Festplattenkapazität</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h2 id="entwicklungsumgebung">Entwicklungsumgebung</h2> |
|
<h3 id="software">Software</h3> |
|
<h4 id="backend">Backend</h4> |
|
<ul> |
|
<li>Entwickler nutzen die IDE Visual Studio 2019 von Microsoft</li> |
|
<li>Zum Untersuchen der Datenbank wird der DB Browser genutzt</li> |
|
<li>Code wird mithilfe des .NET Komplierers kompiliert</li> |
|
<li>Als Betriebssystem wird Microsoft Windows genutzt</li> |
|
<li>Als Codeverwaltung wird Gitlab CE genutzt</li> |
|
<li>Als CI/CD Tool wird Gitlab CI/CD genutzt</li> |
|
</ul> |
|
<h4 id="frontend">Frontend</h4> |
|
<ul> |
|
<li>Entwickler nutzen den Code Editor Visual Studio Code von Microsoft</li> |
|
<li>Codequality Kontrolle wird von dem Codelinter "ESLint" unterstützt</li> |
|
<li>Node JS</li> |
|
<li>Verschiedene Node JS Tools werden zur Unterstützung genutzt (z.B. nodemon)</li> |
|
<li>Als Betriebssystem wird Microsoft Windows oder Ubuntu 19.04 genutzt</li> |
|
<li>Als Codeverwaltung wird Gitlab CE genutzt</li> |
|
<li>Als CI/CD Tool wird Gitlab CI/CD genutzt</li> |
|
</ul> |
|
<h3 id="hardware">Hardware</h3> |
|
<h4 id="backend-und-frontend">Backend und Frontend</h4> |
|
<ul> |
|
<li>Computer mit einem amd64 Mehrkernprozessor, mind. 8 GB RAM und mind. 1 GB freiem Festspeicher</li> |
|
</ul> |
|
<h3 id="orgware">Orgware</h3> |
|
<h4 id="backend-und-frontend">Backend und Frontend</h4> |
|
<ul> |
|
<li>Das Team nutzt Slack zur Kommunikation</li> |
|
<li>Als Codeverwaltung wird Gitlab CE genutzt</li> |
|
<li>Als CI/CD Tool wird Gitlab CI/CD genutzt</li> |
|
</ul> |
|
<h2 id="produktfunktionen">Produktfunktionen</h2> |
|
<h4 id="annahmen-und-definitionen-zu-produktfunktionen">Annahmen und Definitionen zu Produktfunktionen</h4> |
|
<blockquote> |
|
<p>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.</p> |
|
</blockquote> |
|
<ul> |
|
<li>Aus einem eingegangenen Antrag wird wird von der Verwaltung mithilfe der gebotenen Funktion ein Kurs erstellt. Hierfür wählt diese einene passenden Dozenten, Raum, und Zeitpunkt(e) 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 dem Zeitpunkt(en) freigegeben.</li> |
|
<li>Im Falle eines "Band"-Kurses wird dem Antragsteller zusammen mit dem Vertrag ein Einzigartiger Link zugestellt. Über diesen Link können sich weiter Mitglieder durch angeben ihrer personenbezogenen Daten zu diesem bereits erstellten Kurs anmelden. Die Anmeldung ist bis zum ersten Unterrichtszeitpunkt möglich.</li> |
|
<li>Die Laufzeit des Vertrags startet zum ersten Unterrichtstermin.</li> |
|
<li>Unterrichtszeiten werden in 15min (1/4 Stunden) blöcken gegeben und geplant.</li> |
|
</ul> |
|
<h3 id="dozentenfunktionen">Dozentenfunktionen</h3> |
|
<h4 id="wochen%C3%BCbersicht-fd01">Wochenübersicht <strong>/FD01/</strong></h4> |
|
<ul> |
|
<li>Der Nutzer sieht eine Übersicht mit von Ihm gegebenen Kursen in den kommenden 7 Tagen, gruppiert nach Wochentag</li> |
|
<li>Mit einem Klick auf einen Kurs gelangt man zu den entsprechenden Kursdetails</li> |
|
</ul> |
|
<h4 id="kursdetails-fd02">Kursdetails <strong>/FD02/</strong></h4> |
|
<ul> |
|
<li>Der Nutzer sieht Details zu einem Kurs</li> |
|
<li>Er sieht alle Schüler, welche an dem Kurs teilnehmen</li> |
|
<li>Er sieht die Einträge zu den den Unterrichtsinhalten der vergangen Unterrichtseinheiten und kann den Inhalt des letzten Termins bearbeiten / erfassen.</li> |
|
</ul> |
|
<h3 id="verwaltungsfunktionen">Verwaltungsfunktionen</h3> |
|
<h4 id="offene-antr%C3%A4ge-fv01">Offene Anträge <strong>/FV01/</strong></h4> |
|
<ul> |
|
<li>Es werden alle neu eingegangenen und nicht bestägtigten Anträge angzeigt.</li> |
|
<li>Mit einem Klick auf einen eingegangen Antrag wird die <a href="#kurs-erstellen-fv02">Kurs erstellen</a> Seite aufgerufen.</li> |
|
</ul> |
|
<h4 id="kurs-erstellen-fv02">Kurs Erstellen <strong>/FV02/</strong></h4> |
|
<ul> |
|
<li>Nach einem eingegegangen Antrag kann basierent auf diesem ein Kurs erstellt werden.</li> |
|
<li>Typ (Einzel, Gruppe, ), Instrument(e), Laufzeit und Personenbezogne Daten werden in der Kurserstllungs Mask vorausgefüllt</li> |
|
<li>Es werden Dozenten angezeigt, welche zu den Instrumentenanforderungen passen</li> |
|
<li>Es werden Räume angezeigt, welche zu den Instrumentenanforderungen passen</li> |
|
<li>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</li> |
|
<li>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.</li> |
|
</ul> |
|
<h4 id="kurs%C3%BCbersicht-fv03">Kursübersicht <strong>/FV03/</strong></h4> |
|
<ul> |
|
<li>In der Kursübersicht werden in Tabellenform alle Kurse zusammen mit ihren Dozenten angezeigt.</li> |
|
<li>Die Tabelle kann spaltenweise sortiert und nach Dozenten- und Kursname gefiltert werden.</li> |
|
<li>Ein Klick auf einen Kurs führt zu <a href="#kursdetails-fd02">Kursdetails</a>.</li> |
|
<li>Ein Klick auf einen Dozenten führt zu <a href="#sch%C3%BCler-eines-dozenten-fv05">Schüler eines Dozenten</a></li> |
|
</ul> |
|
<h4 id="sch%C3%BCler%C3%BCbersicht-fv04">Schülerübersicht <strong>/FV04/</strong></h4> |
|
<ul> |
|
<li>Es werden in Tabellenform alle Schüler mit Ihren Kursen angezeigt, ein Kurs pro Zeile |
|
<ul> |
|
<li>Ein Schüler kann also mehrere Zeilen umfassen</li> |
|
</ul> |
|
</li> |
|
<li>Die Tabelle kann spaltenweise sortiert und nach Schüler- und Kursname gefiltert werden.</li> |
|
</ul> |
|
<h4 id="sch%C3%BCler-eines-dozenten-fv05">Schüler eines Dozenten <strong>/FV05/</strong></h4> |
|
<ul> |
|
<li>Es werden alle Schüler des ausgewählten Dozenten angezeigt.</li> |
|
</ul> |
|
<h4 id="raum%C3%BCbersicht-fv06">Raumübersicht <strong>/FV06/</strong></h4> |
|
<ul> |
|
<li>Es werden alle Räume mit Grundlegenden Informationen angezeigt. |
|
<ul> |
|
<li>aktuelle Belegung</li> |
|
<li>Instrumente</li> |
|
</ul> |
|
</li> |
|
<li>Es wird ein Button zum erstellen von neuen Räumen angzeigt</li> |
|
</ul> |
|
<h4 id="raumdetails-fv07">Raumdetails <strong>/FV07/</strong></h4> |
|
<ul> |
|
<li>Es werden alle Informationen zu einem Raum Angzeigt. |
|
<ul> |
|
<li>Name (bearbeitbar)</li> |
|
<li>aktuelle Belegung</li> |
|
<li>Instrumente (bearbeitbar)</li> |
|
<li>Nächste 5 Unterrichtseinheiten in diesem Raum</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h4 id="finanz%C3%BCbersicht-fv09">Finanzübersicht <strong>/FV09/</strong></h4> |
|
<ul> |
|
<li>Es werden die gesamten monatlichen Einnahmen der Musikschule angzeigt.</li> |
|
<li>Es werden die Zahlungen an die Dozenten, aufgeschlüsselt nacht Dozent angezeigt.</li> |
|
</ul> |
|
<h3 id="sonstige-funktionen">Sonstige Funktionen</h3> |
|
<h4 id="login-f01">Login <strong>/F01/</strong></h4> |
|
<ul> |
|
<li>Der Nutzer kann sich mit Benutzername und Passwort anmelden.</li> |
|
<li>Benutzername und Passwort können von dem Administrativen Nutzer mithilfe von Direktzugriff auf das System angelegt werden</li> |
|
</ul> |
|
<h4 id="mitglied-zu-kurs-hinzuf%C3%BCgen-f02">Mitglied zu Kurs hinzufügen <strong>/F02/</strong></h4> |
|
<ul> |
|
<li>Wenn ein Schüler einen Gruppenkurs erstellt hat, erhält dieser mit seiner Kursbestätigung einen Einladungslink, welcher auf eine "Antrag-Lite" Seite führt. |
|
<ul> |
|
<li>Hier können sich weiter Mitglieder der Gruppe/Band in diesen Kurs eintragen.</li> |
|
<li>Dafür müssen diese nur Ihre Personenbezogenen Daten angeben, Sie werden in der über den Link identifizierten Kurs eingeschrieben.</li> |
|
<li>Dies muss vor dem ersten Unterrichtstermin geschehen.</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h4 id="antrag-stellen-f03">Antrag Stellen <strong>/F03/</strong></h4> |
|
<ul> |
|
<li>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 <a href="#offene-antr%C3%A4ge-fv01">Offene Anträge</a> eingesehen und weiter verarbeitet werden können.</li> |
|
<li>Personenbezogene Daten: |
|
<ul> |
|
<li>Vorname</li> |
|
<li>Nachname</li> |
|
<li>Geb. Datum</li> |
|
<li>Geb. Ort</li> |
|
<li>PLZ</li> |
|
<li>Ort</li> |
|
<li>Straße</li> |
|
<li>Hausnummer</li> |
|
<li>Telefon</li> |
|
<li>EMail</li> |
|
<li>BLZ</li> |
|
<li>Bankname</li> |
|
<li>Kontonummer</li> |
|
</ul> |
|
</li> |
|
<li>Kursbezogene Daten: |
|
<ul> |
|
<li>Instrumente</li> |
|
<li>Laufzeit</li> |
|
<li>Unterrichtstyp</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<h2 id="benutzeroberfl%C3%A4che">Benutzeroberfläche</h2> |
|
<blockquote> |
|
<p>Was sind die grundlegenden Anforderungen an die Benutzeroberfläche (Bildschirmlayout, Dialogstruktur, ...)?</p> |
|
</blockquote> |
|
<h3 id="dialogstruktur">Dialogstruktur</h3> |
|
<p>Im Folgenden wird die grobe Dialogstruktur einer fehlerfreien bzw. konfliktfreien Benutzung des Systems gezeigt wird. |
|
Fehlereingaben haben eine akkumulierte Fehlermeldung zur Folge.</p> |
|
<h4 id="startseite">Startseite</h4> |
|
<p><img src="img/Hauptseite.png" alt="Hauptseite" title="Startseite"></p> |
|
<h4 id="%C3%BCbersichtsseite-dozenten">Übersichtsseite Dozenten</h4> |
|
<p>Die Übersichtsseite Dozenten ist die Startseite des Dozenten, die der Dozent nach der Anmeldung /F01/ erreicht.</p> |
|
<p><img src="img/Hauptseite_Dozent.png" alt="Hauptseite" title="Hauptseite Dozent"></p> |
|
<h4 id="%C3%BCbersichtsseite-verwaltung">Übersichtsseite Verwaltung</h4> |
|
<p>Die Übersichtsseite Verwaltung ist die Startseite der Verwaltung, die die Verwaltung nach der Anmeldung /F01/ erreicht.</p> |
|
<p><img src="img/Hauptseite_Verwaltung.png" alt="Hauptseite" title="Hauptseite Dozent"></p> |
|
<h3 id="bildschirmlayout">Bildschirmlayout</h3> |
|
<p>Das Frontend wird mithilfe der JavaScript Bibliothek React erstellt, 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 Desings entwickelt.</p> |
|
<blockquote> |
|
<p>Ausnahme sind die Administrationsfunktionen</p> |
|
</blockquote> |
|
<h2 id="testf%C3%A4lle">Testfälle</h2> |
|
<ol> |
|
<li>Der Login funktioniert und erlaubt nur Zugriff auf authorisierte Bereiche / Ansichten.</li> |
|
<li>Anonyme Nutzer können Anträge stellen, diese gehen in der Datenbank ein.</li> |
|
<li>Die Verwaltung kann Anträge verarbeiten und daraus Kurse erstellen.</li> |
|
</ol> |
|
<ul> |
|
<li>Der Antragsteller wird über die Verarbeitung informiert.</li> |
|
</ul> |
|
<ol start="4"> |
|
<li>Die Übersichtsseiten zeigen korrekte Informationen an.</li> |
|
</ol> |
|
|
|
</body> |
|
</html>
|
|
|