Die Wiki-Seite sollte mit dem Namen des Projekts, einer kurzen Beschreibung und den Namen der Teilnehmer anfangen. (Da die Wiki öffentlich ist, könnt ihr verlangen, dass eure Namen entfernt werden, wenn das Semester vorbei ist, das hat aber bisher noch kaum jemand getan.)
Die Projektplanung (Ziele, Zwischenziele, Literatur, Hilfsmittel, wenn möglich Zeitplan, Aufgabenverteilung, voraussichtliche Bestandteile des Projekts) sollte in der Wiki stehen,
Die Protokolle sollen kontinuierlich geführt werden und möglichst materialreich sein, auch Irrwege und Entscheidungen dokumentieren.
Die strukturierte Dokumentation soll das Projekt umfassend darstellen, so dass andere es anhand der Dokumentation verstehen und gegebenenfalls nachmachen können. Dazu gehört:
Eine Einführung (sollte gut lesbar sein).
Eine gegliederte Darstellung der Bestandteile des Projekts und ihrer Beziehung. Insbesondere sollen die einzelnen Bestandteile genau erklärt werden. Dazu können Codebeispiele, aber auch Theorieteile gehören.
Ein kleiner Bericht über den Verlauf der Projektarbeit.
Fazit und Ausblick.
Literaturangaben, verwendete Software-
Was den Code betrifft, eine Bitte:
fügt doch bitte auf eurer Wiki-Seite eine gezipte Version eures letzten „gültigen“ Codes ein. Schickt mir außerdem diese gezipte Version. (Wenn ihr noch nichts in der Wiki hochgeladen habt und keine Lust, rauszubekommen, wie das geht, kann ich das auch für euch machen, wenn ihr mir das in der Email mit der zip-Datei schreibt.)
Teil der Dokumentation sollte ein Verzeichnis der Python-Pakete (mit Versionsnummer) sein, die ihr verwendet habt. Durch „pip freeze > requirements.txt“ bekommt ihr ein solches Verzeichnis eurer Pakete. Dieses Verzeichnis könnt ihr mit in die zip-Datei packen oder aber auf einer separaten Wiki-Seite angeben.
Häufig stellt die gegliederte Darstellung des Projekts das größte Problem dar. Dazu müsst ihr euch fragen, welche Gliederung dem Verständnis dient. Macht auch von der Möglichkeit der Wiki Gebrauch, den Inhalt auf verschiedene Seiten zu verteilen und entsprechend zu verlinken, wo sich das anbietet. Zur Anregung einige Beispiele: