Dies ist eine alte Version des Dokuments!
Die Projektdokumentation soll die Ergebnisse eurer Arbeit zusammenfassen und nach außen präsentieren. Sie soll so geschrieben sein, dass ein technisch interessierter Außenstehender ohne Wissen über eurer Projekt verstehen kann, was ihr gemacht habt und alle nötigen Informationen hat, um euer Projekt nachzubauen oder weiter zu entwickeln.
Für die Projektdokumentation bekommt ihr maximal 20 Punkte. Insgesamt gibt es im Kurs 100 Punkte, ihr braucht 50%, um zu bestehen. Die Lehrveranstaltung wird im Sommersemester 2020 nicht benotet.
Die Projektdokumentation orientiert sich grob an einer wissenschaftlichen Arbeit mit Einleitung, Methodenteil, Ergebnissen und Fazit. Zur besseren Übersichtlichkeit sollte die Seite durch Überschriften gegliedert werden. Die folgenden Inhalte gehören rein:
Hier geht ihr ins Detail. Jeder wichtige Bestandteil eurer Lösung (z.B. „GUI“, „Erkennung von X im Bild“, „Berechnung von Y“, „Modell für die Simulation von Z, „Anwendung des Algorithmus ABC“ ) bekommt einen eigenen Abschnitt.
Dabei sollte kein für die Funktion wesentlicher Teil komplett unerwähnt bleiben. Erklärt insbeondere diejenigen Teile ausführlich, in die ihr besonders viel Hirnschmalz gesteckt habt, oder zu denen es aussagekräftige Messdaten gibt.
Hierher gehört…
Eine Sammlung des Kompletten Programmcodes gehört zu eurer Dokumentation. Wenn ihr wollt, könnt ihr dafür eine gesonderte Seite, so dass sie verfügbar sind, ohne den Lesefluss allzu sehr zu stören.
Hier solltet Ihr eine lauffähige Version eures Codes inkl. aller verwendeten Libraries als .zip-Datei zum Download anbieten. Selbst wenn ihr eine git-Seite habt, ladt bitte den Code herunter als .zip und ladet hier hoch. Grund: der Code soll zugänglich sein, selbst wenn ihr z.B. euren github-Account löscht.
[[https://www.tu-berlin.de | TU Berlin]]
).