Checklist: Abgabe Programmierprojekt

Programmdateien

  • Alle Programmtexte und notwendigen Hilfsdateien in einem Hauptverzeichnis
  • Keine Umlaute (Zeichen mit ANSI-Code > 127) in den Dateinamen
  • Kein Dateiname länger als 31 Zeichen (Einschränkung MacOS)
  • Im Hauptverzeichnis eine README.TXT-Datei, die Auskunft gibt über:
  • alle Dateien und ihre Funktion.
  • Plattform (Betriebssystem, Programmierumgebung mit Versionsangabe), auf der das Programm lauffähig war.
  • Komponenten (z.B. Gertwol, Tagger), die im Projekt verwendet werden, aber nicht teil der Abgabe sind mit Versionsangabe.
  • wie Hauptfunktion(en), die das/die Programme ausmachen, aufgerufen werden.

Technische Dokumentation

Die Dokumentation ist gebunden in Papierform sowie elektronisch (HTML-, RTF- oder PDF-Dateien) abzugeben

Die Dokumentation enthält folgende Informationen:

  • Ziele und Arbeitsschritte des Projekts mit Angaben über das Erreichen
  • positive und negative Resultate auflisten (Dies funktioniert gut weil, ... Das hat nicht geklappt, weil…)
  • Dokumentation der verwendeten Konzepte, Algorithmen, Resourcen (Dies geschieht am besten, während man die Sache erarbeitet! Nicht am Schluss noch machen!)
  • Mit Ablaufdiagrammen lässt sich ein System oft übersichtlich zusammenfassen.
  • Woher kommt dieser Algorithmus? Woher kommt diese Klassifikation? Woraus wurde diese Liste entnommen?
  • Dokumentation der verschiedenen Datenformate (Input- und Output-Formate bei Dateien)
  • kommentierte Literatur-/Linkliste (bzw. Zusammenfassungen, falls dies Teil der Aufgabenstellung war)
  • Hinweise auf Ausbau-/Erweiterungsmöglichkeiten
  • Kommentierter Programmkode (falls zu gross, nur in der elektronischen Version)

Kurzpräsentation

In der mündlichen Präsentation (ca. 15 Min.) müssen folgende Punkte klar herauskommen:

  • Problemstellung
  • Lösungsansatz
  • Resultate euerer Arbeit

Zielpublikum für die Präsentation (bezüglich vorauszusetzendem Wissen) sind Computerlinguistik Studierende, die den Akzess bestanden haben. Die mündliche Präsentation bedingt, dass wenig technische Details vermittelt werden können (dafür ist die technische Dokumentation da).