Randbedingungen für die Dokumentation

Pflichtenheft

In realen Projekten würden Sie zunächst ein Lastenheft erhalten, dass Sie in ein Pflichtenheft, Systembeschreibung, Hardware- und Software-Systembeschreibung herunterbrechen, wobei parallel dazu die Systemtests und Hardware-/Softwaresystemtests beschrieben werden.

Dieses Vorgehen ist für die Arbeiten in EST zu umfänglich und wird wie folgt reduziert. Die Angaben auf der Wikiseite Ihres Projekts, sowie die während der Projektgespräche dienen als Lastenheft. Daraus ist ein Pflichtenheft zu erstellen, welches die Projektziele in obligatorische („Muss“), gewünschte („Soll“) und fakultative („Kann“) Aufgaben untergliedert. Zusätzlich ist es auch möglich Projektziele explizit auszuschließen („Nicht benötigt“).

Um das Pflichtenheft gut zu strukturieren, ist eine Vorlage in der Projektbeschreibung angelegt.

Offene Punkte Liste

Als weitere Aufgabe sollen Sie die Offene-Punkte-Liste (OPL) führen. Darin sollten wichtige Informationen und Aufgaben (z.B. aus Projektgesprächen) zusammengefasst sein. Ziel ist dabei nicht zwangsläufig, dass am Ende Ihres Projekts alle Punkte abgearbeitet sind. Die OPL kann auch Punkte enthalten, welche zukünftig noch bearbeitet werden müssen oder Ideen, welche noch umgesetzt werden könnten. Sie soll auch dazu dienen, dass andere - wie z.B. Ihre Nachfolger - Ihre Entscheidungen verstehen können.

Die Offene Punkte Liste sollte bevorzugt über das Ticketsystem von Redmine geführt werden.

Modulblockbild

Für die Software ist ein Modulblockbild/Blockschaltbild beizufügen. Dies soll die Unterfunktionen und ihre gerichteten Schnittstellen zueinander (z.B. globale Variablen, Parameter) darstellen.

Dazu ist eine Vorlage in Ihrer Projektbeschreibung im Wiki angelegt. Dort ist dies unter Softwareübersicht zu finden. Auch wenn Sie keine State Machine verwenden, bietet es sich an in ähnlicher Weise die Zusammenhänge der einzelnen (Unter)funktionen zu beschreiben.