**DEADLINE!** 17.02.23: Project Documentation/Link
Required:
-
README.md
-
CHANGELOG.md
-
WIKI: technical and enduser documentation
-
create a project documentation till 17.02.23 ! -
send the link to the gitlab project to the professor till 17.02.23 !
Punkteverteilung Projektarbeit
Anforderungsanalyse
-
0 - Keine Anforderungen dokumentiert -
1 - Rudimentäre Anforderungen vorhanden -
2 - Arbeit mit Milestones/Labels -
3 - Unterteilung der Anforderung (z.B. fachliche/technische Anforderungen), Verknüpfung der Anforderungen untereinander, Verlinkung mit git-Commits
Softwarearchitektur & Clean Code
-
0 - Keine Softwarearchitektur erkennbar (z.B. keine Packageuntergliederung) -
1 - Package-Struktur vorhanden und mit Klassendiagramm dokumentiert. Dokumentation und Begründung welches Architekturmuster gewählt wurde. -
2 - SOLID-Prinzipien angewandt und dokumentiert. -
3 - Interfaces und Factories sinnvoll eingesetzt. Dokumentiert wie Komponenten miteinander kommunizieren.
git
, Dokumentation, Clean Code
-
0 - Commits ohne Commit-Messages -
1 - Commits mit Commit-Messages -
2 - Tags & Changelog vorhanden und gepflegt. Readme, inkl. Beschreibung wie das Programm gestartet wird, vorhanden. -
3 - git
-Vorgehen inkl. branching dokumentiert und angewandt
GUI
-
0 - kein GUI vorhanden -
2 - GUI vorhanden über die die Programmfunktionen ausführbar sind -
4 - GUI austauschbar gehalten: keine Logik im GUI-Code -
6 - (Potentiell) langlaufende Abfragen asynchron. Eine GUI-Operation (z.B. Speichern) ist ausreichend.
Abschlusspräsentation/Endabgabe
-
0 - Nicht Präsentiert -
1 - Alle Teammitglieder aus der Projektgruppe haben präsentiert -
2 - Projektgruppe hat vollständig an Rückfragen-Termin teilgenommen -
3 - Projektdokumentation vorhanden. Beschreibung, was das Projekt macht, wie es gestartet wird, was die Hauptarchitektur-Entscheidungen und -Prinzipen waren, wie diese umgesetzt wurden, known issues, Reflexion was man anders machen würde.
Edited by Danze Manuel