Projekthandbuch

Projekthandbuch

In diesem Dokument befinden sich wichtige Informationen zur Projektorganisation und -durchführung.

Verwendung von GitHub

Hier wird beschrieben, wie die GitHub Mechanismen verwendet werden sollen.

Verwendung von Sprachen

	Sprache
Dokumentation in Wiki und README	Deutsch
Statusreports	Deutsch
Programmcode	Englisch
GitHub Commit Messages	Englisch
GitHub Issues	Deutsch

Im Glossar definierte Begriffe werden in Texten kursiv hervorgehoben.

GitHub Commit Messages

Bereich	Messagetyp
Dokumentation	DOC: <nachricht>
Frontend	FE: <nachricht>
Backend	BE: <nachricht>

Umgang mit Issues

Anforderungen werden in der Anforderungsdokumentation als Übersicht gruppiert. Einzelne Arbeitsschritte werden in der Übersicht angezeigt. grob im Anforderungsdokument -> genauer im Issue mit Abnahmekriterien -> Arbeitspakete

Statusreports

Wöchentliche Statusreports zu dem Projekt werden in den Diskussions unter Statusreports veröffentlicht.

Arbeitszeiterfassung

Für die Erfassung von einer Gesamtarbeitszeit werden die individuellen Zeiten gemessen und in die im Projekt bereitgestellte Tabelle eingetragen. Hierbei werden die Zeiten je Thema je Person aufgeteilt. Die Summierung der Zeiten soll von der Tabelle in Gesamtzeiten übertragen werden.

---

Projektteilnehmer:

Person	Rolle
Dr. Roland Schätzle	Auftraggeber
Joshua Slaar	Projektmanagement, Backendentwicklung
Tom Schütt	Projektmanagement, Authentifizierung, Schnittstelle, (Frontend)
Benjamin Loidl	Frontendentwicklung, Schnittstelle
Manuel Brauneis	Externe APIs, Backendentwicklung
Leonard Michalsky	Datenbankdesign, Backendentwicklung

Rollen der Teilnehmer werden ggf. aktualisiert.

---

Aufbauvorgabe des Auftraggebers

Der Aufbau umfasst eine Weboberfläche, einen Server und eine Datenbank, sowie Zugriffe auf externe Service.

graph LR;
API{{"externer Service"}}
UI["Weboberfläche"]
Server[[Server]]
DB[("Datenbank")]

subgraph App[Applikation]
direction TB
    UI --- Server
    Server --- DB
end
App -.- API

Loading

Sprachtemplates

Die Sätze der Anforderungen sollen nach folgendem Sprachschema genutzt werden.

flowchart LR
A1[Das System]
A2[Die Komponente]

B1[muss]
B2[soll]
B3[sollte in Zukunft]

C1[" "]
C2["<*wem*> die Möglichkeit bieten"]
C3["fähig sein"]

D1["<*Was zu tun*>"]
N1(" ")
N2(" ")

A1 & A2 --- N1
N1 --- B1 & B2 & B3
B1 & B2 & B3 --- N2
N2 --- C1 & C2 & C3
C1 & C2 & C3 --- D1

Loading

---

Rechtliche Hinweise

Die Freischaltung einer Premiumfunktion ist aufgrund der rechtlichen Situation durch Nutzung der Education-Lizenzen nicht geplant.

Sobald ein Einkommen generiert wird muss eine UmsatzsteuerID vom Finanzamt beantragt werden. Falls eine Kommerzialisierung erfolgen sollte, ist geplant ein Unternehmen zu gründen.

Verwendung von geschlechtergerechter Sprache

Es wird versucht geschlechtsneutrale Sprache zu verwenden. Ansonsten wird das generische Maskulinum verwendet.