PTP - Projektdokumentation

Inhalte

Erstellung einer ausführlichen Aufgabenbeschreibung:

• Projektidee, Anforderungsdefinition, Userstories, ggf. Mockups, CRC-Cards

Konzeption und Projektplanung:

• Grobbeschreibung für das Gesamtprojekt
• Aufteilung / Modularisierung / Programmstruktur / packages ...
• Prioritätenliste (must items, ..., nice to have)
• Zeitplan (--> Meilensteine)
• Testplan (--> JUnit)
• Darstellung der Beziehungen zwischen den Klassen (--> UML)

Stand des Projektes

• Was ist fertig?
• Was wurde weggelassen/verworfen (warum)?
• Wo gibt es "Macken"?
• Wie war die "workload" tatsächlich?
• Aufteilung der Arbeit in der Gruppe?

Funktionsbeschreibung des Programms

• kurze Bedienungsanleitung (Start, Ende, wichtige Menüs, Parameter, Vorgehensweise, ...)
  --> was muss ein Anwender wissen?
• ggfs. Screenshots der Programmfenster
• ggf. Hinweise zur Übersetzung, classpaths usw.

Dokumentation der erstellten Klassen mittels JavaDoc

• javadoc -author -version -[public | protected | private] -use (evtl. weitere Optionen)

Kommentierung der durchgeführten Tests

Verschiedenes (falls relevant)

• Kommentierung der verwendeten Programmierumgebung(en)
• Hinweis auf Probleme, die zu lösen waren
• Kommentierung interessanter Java-Klassen, die benutzt wurden
• Was musste neu erarbeitet werden, wo konnten relevante Komponenten oder Beispiele genutzt werden?

Jedes Dokument muss enthalten:

• Überschrift oder Kopfzeile: PTP 2024
• Titel: (z.B. Projekt "Monopoly")
• Gruppe, Autor(en)
• Datum der Erstellung / Änderung(en)

Fiktives Beispiel für Quellcode

Schön wären außerdem

• Eine Kurzinfo/Zusammenfassung (abstract)
• Bei längeren Docs ein Inhaltsverzeichnis
• Screenshots oder Zeichnungen/Diagramme, wo sinnvoll

Bitte die hilfreichen Überlegungen/Stichworte zum Inhalt der Beschreibungen beachten!

Beispiele aus den Vorjahren

• Beispiel 1 (PDF) *
• Beispiel 2 (PDF) *

*) Nur im Intranet der Informatik zu lesen.