Anforderungen an die Dokumentation / JUnit Tests

Software Engineering I, WS0910

In der Regel ist jedes Feature mit mindestens einem JUnit Test zu testen. Für jedes Szenario wird eine Testmethode geschrieben, die die textuelle Szenariobeschreibung im JavaDoc enthält. Außerdem soll aus dem JavaDoc für die Klasse ersichtlich sein zu welcher Anforderung aus dem Anforderungsdokument sie gehören (Referenz auf das Kapitel).

Die Kommentare im Quellcode sollen wie heute in der Vorlesung gezeigt die einzelnen Schritte kurz erklären.

In jedem Release werden die Kunden die ausführliche Dokumentation eines bestimmten Features wünschen. Die Ausführlichen Features sollen in einem technischen Handbuch Dokumentiert werden und enthalten neben Anforderungsbeschreibung und textuellen Szenarien auch Objektdiagramme mit Start- und Endsituation zu den Szenarien, aus den Objektdiagrammen abgeleitete Klassendiagramme sowie ein einleitendes Kapitel zur Architektur mit einem Komponentendiagramm. Außerdem muss ein Hinweis / Link auf die relevanten JUnit tests vorhanden sein, sowie die Ergebnisse der Code Coverage und JavaDoc angesprochen werden. Die Kapitelstruktur sollte sich an folgenden Vorschlag halten:

0. Startseite mit Kontaktinformationen wie beim Anforderungsdokument
1. Einleitung
2. Architektur
3. Schlüsselanforderungen
3.1 Login
3.2 KI Architektur
3.3 <To be announced>
3.4 <To be announced>
4. Glossar

Im ersten Release ist die ausführliche Dokumentation des Login gefordert. Im zweiten Release ist die ausführliche Dokumentation der KI Architektur gefordert. Die ausführlich zu Dokumentatierenden Features der nächsten Releases werden noch bekanntgegeben.