Softwaretechnik-Projekt SS2010

Abnahme

• Benutzerhandbuch des Programms sollte über JavaHelp umgesetzt sein, keine separate Abgabe in Papierform nötig. JavaHelp nach Möglichkeit kontextsensitiv.
• Technische Dokumentation (als ein einzelnes, einheitlich layoutetes Dokument abzugeben):
  
  • Use-Case-Diagramm + Beschreibung (angepaßt an aktuellsten Programmstand)
  • Klassendiagramme: am Besten kein Gesamt-Diagramm, sondern Diagramme einzelner zusammenhängender Bereiche, z.B. "Datenmodell" oder "Client-Server-Kommunikation". Dabei der Übersichtlichkeit zuliebe nur für den jeweiligen Bereich wichtige Variablen und Methoden ins Diagramm packen, keine Helper. Jedes Diagramm jeweils dokumentieren (Klassen, Felder und Zusammenhänge beschreiben)! Beschreibung sollte sich hauptsächlich auf Zusammenhänge und Konzepte beziehen, da Details zu einzelnen Methoden aus der JavaDoc geholt werden können.
  • Dokumentieren von eingesetzten Designpatterns (in diesem Projekt gab es leider wenig Spielraum für sowas) und sonstigen relevanten Logiken (jeweils kleines Klassendiagramm der Umsetzung des Patterns + Beschreibung)
  • Zwei Sequenzdiagramme von nicht-trivialen Use-Cases + Beschreibung (Diagramm ohne Beschreibung: 0 Punkte)
• Außerdem: Stundenzettel gesamt
• Info für Gruppe 2: Druckfunktionalität wg. Absprung TJ als optionales Feature deklariert.

Infos

Literaturtips