PTP - Infos zur Dokumentation im Projektteil

Um ein möglichst "rundes" Bild von dem bearbeiteten Projekt zu liefern, sollte man sich folgende Punkte überlegen/Perspektiven einnehmen und ggf. kompakt beschreiben:

Übergreifende, abstrahierte Beschreibung ("Vogelperspektive")

• worum geht's?
• wie funktioniert das System?
• welche Konzepte/Ansätze wurden wie umgesetzt?
• wie wird / wurde die Arbeit aufgeteilt?
• Überlegungung zum Testen
• Stand / offene Punkte / Ausbaumöglichkeiten ...
• "kritische Würdigung" inkl. workload und Abweichungen vom Zeitplan

(system-)technische Beschreibung

• wie läuft das Zusammenspiel der Klassen?
• welche Probleme wurden wie gelöst?
• was liegt noch "im Argen"?
• Details zu Algorithmen
• spezielle Pakete etc.
• Plattformabhängigkeiten
• Hinweise zur Übersetzung, Java-Version
• Fehlerbehandlung
• vorhandene Tests
• Klassen/UML-Diagramme (IST)
• ...

Beschreibung für Benutzer

• wie startet man das Programm?
• was ist dann zu tun (Vorgehensweise, Alternativen, Fehler)?
• Hinweise zu Eingabe-Syntax und Wertebereichen
• Probleme / Lösungen
• ggf. Screenshots, Muster-Ein/Ausgabe-Sequenzen usw.
• ...

Es geht dabei nicht darum, "Romane" zu schreiben, sondern eher kompakt und informativ die wesentlichen Informationen für die verschiedenen Sichten zusammenzustellen. Kommentare im Programmcode (Javadoc für die API, sonstige Kommentare für interne Details) gehören selbstverständlich dazu. Dies kann (ausser der Programmcode-Kommentierung) durchaus in einem gemeinsamen Dokument geschehen.