Kurze Erklärung wie in Gruppe 11 und Gruppe 21 die Analyse und Dokumentation bewertet werden bzw. wie die Vorgaben vom Tutor interpretiert werden.
Analyse
Unter Analyse sind hier weniger die Analyse der Problemstellung als die Beschreibung der Vorgehensweise und Lösung des Problems gemeint. Das heißt, bitte die Textaufgabe nicht einfach nochmal wiedergeben - auch mir liegt das Übungsblatt vor… :D Vielmehr soll die Analyse Antworten auf folgende Fragen liefern:
- Annahmen: Wie interpretierst du die Aufgbe?
- wo/wie sollen Eingaben erfolgen
- in welchem Format sollen diese Erfolgen
- hast du zusätzliche Annahmen getroffen weil Aufgabenstellung da nicht eindeutig war
- Modellierung
- welcher Entwurfsmuster
- Hintergedanken zum Code
- hast du das Programm in Funktionen zerlegt und/oder in modulen ausgelagert? eine kurze Erklärung dazu!
- welchen Algorithmus und wieso diesen?
- …zugegeben, Algorithmus klingt etwas übertrieben für unsere Zwecke, aber z.B. warum diese Datenstruktur? warum z.b. Modulo-Operator hierfür geeignet? …)
Dokumentation
Unter Dokumentation fallen einem mehrere Sachen ein: Code-Doku, Programm-Doku, Handbuch… Wir fokussieren uns in diesem Tut auf:
- Code-Dokumentation
- Ist in diesem Tutorium mit guten Kommentaren und Docstrings abgedeckt
- README
- Stand des Programms (bekannte Bugs etc.)
- Was brauche ich zum Auführen des Programms (Python Version, wie heißt das Modul was ich ausführen muss, muss ich weitere Libraries installieren, etc.)
- Antworten auf Fragen, wo ihr meint, dass der User haben könnte
- Wichtig: Wie Bediene ich das Programm (was muss ich eingeben etc.) => Benutzerhandbuch
- Die Datei idealerweise README umbenennen. So ziemlich jedes open-source Projekt kommt mit einer README-Datei
Note:
Nutzt die Gelegenheit euch darin zu üben, kurze und prägnante Sätze zu formulieren :)