Formales #

• Code ist sauber formatiert und aufgeräumt, d.h. es gibt keine Code-Leichen in Form von unbenützten Code-Fragmenten oder unnötigem Debug-Code. Testcode ist erlaubt und erwünscht.
• Die Java-Klassen produzieren keine Warnings bei der Eclipse Standardeinstellung.
• Alle verwendete Packages aus dem Internet sind referenziert.

Struktur #

• Die Struktur folgt den Prinzipien der objektorientierten Programmierung.
• Die Gesamtaufgabe ist sinnvolle in Klassen unterteilt.
• Entwurfsmuster werden zweckmässig und richtig angewendet.
• Die Aspekte Model – View – Controller werden klar getrennt.

Benutzerschnittstelle #

• Die Benutzerschnittstelle ist klar aufgebaut und sinnvoll in Untereinheiten aufgeteilt.
• Die Erscheinung der Benutzerschnittstelle widerspiegelt sich klar in den Klassen und dem Code.
• Fehleingaben werden möglichst frühzeitig erkannt und benutzerfreundlich abgefangen (Input Validation).
• Die Benutzerschnittstelle ist gut wartbar und kleine Fehler textlicher Art lassen sich schnell finden und beheben.

Algorithmen: #

• Die Algorithmen sind klar vom Rest des Programms getrennt.
• Bei der Programmierung wird auf die Testbarkeit der Algorithmen geachtet.
  • ... Unit Tests

Formales, Ausführung Doku #

• Typographie
• Graphiken
• Formeln
• Darstellung

Struktur / Leserführung #

• Der Berichtsteil ist der Erläuterung dienlich strukturiert.
• Der Leser wird durch den Bericht geführt.
• Es ist einfach, schnell den Überblick zu gewinnen.
• Das Pattern MVC soll im Fachbericht nicht rezitiert werden.
• Validierung am Ende des Fachteils. Welche Komponenten werden mit Unit Tests getestet und welche Testcases werden abgedeckt?

Verständlichkeit #

• Dem Leser wird die Struktur der Software und die Implementation klar vermittelt.
• Die Übersicht folgt dem Top – Down - Prinzip und geht vom Grossen zum Kleinen.
• Wo sinnvoll, werden UML - Diagramme verwendet.
• Die Aufteilung in Hauptteil und Anhang wird sinnvoll gemacht.

• Link zwischen GUI und Code
  • z.B. mit Diagramm / Screenshot und Legende
  • ... wenn ich im GUI was anpassen möchte, wo finde ich die GUI Komponente im Code?
• Model übersichtlich dokumentieren
  • kein Monster UML bis ins letzte Detail
  • ... besser eine Tabelle mit Klassennamen und Beschreibung.

Vollständigkeit #

Alle bezüglich Code wichtigen Aspekte sind durch die Dokumentation (Fachbericht / API-Doc) abgedeckt. Eine Java – versierte Person kann sich schnell und effizient einarbeiten.

Beispiel zur Software - Beschreibung #

Beispiel als PDF