Projektdokumentation


Auf diesen Seiten wird die Fallstudie zum Weblog Projekt präsentiert (siehe goto auf einen Blick). In der Design Phase habe ich mich dazu entschlossen die Dokumentation im Weiteren als HTML Seiten zu präsentieren. Bis zur Analysephase bestehen die Dokumente aus migrierten Word Dokumenten.

Inhaltsverzeichnis



1. Beschreibung des Projektauftrages


1.1 Aufgabenstellung, Hintergrund, Form Framework

Der eigentliche Projektauftrag zur Fallstudie Weblog ist unter (siehe goto Projektauftrag) zu finden. Er beschreibt die Aufgabenstellung, den Hintergrund der Fallstudie und das zu entwickelnde FormHandling Framework. Er enthält ausserdem einige unvollständige Interfaces, welche in die Applikation zu integrieren sind.

1.2. Ausgangslage

Im Rahmen der Projektarbeit im Kurs Java NDK an der HSZ-T soll eine Weblog Software als einfache Web Applikation erstellt werden. Das Schwergewicht der Aufgabe liegt in der Anwendung der erlernten Technologien (Servlets, JSP, Taglibs, XML, Reflection).

1.3. Projektziel

Ziel des Projektes ist es, eine Webanwendung WEBLOG zu realisierien, mit deren Hilfe Weblog Beiträge veröffentlicht und verwaltet werden können. Die Beiträge sollen von jedem Internet User einsehbar sein, sie dürfen aber nur von registrierten Autoren erfasst und bearbeitet werden.
Es soll keine komplette Weblog Lösung erstellt werden. Das Ziel der Arbeit ist das Design und die Implementation eines Web Application Framework (WAF) ohne dabei auf Struts zurückzugreifen.

1.4. Projektumfeld

Der Auftraggeber für dieses Projekt ist die Schulleitung HSZ-T.
Der Projektleiter, seitens des Auftraggebers ist Herr Daniel Nydegger. Herr Nydegger steht als Ansprechpartner für die funktionalen Anforderungen während der gesamten Dauer dieses Projektes zur Verfügung.

Projektleiterin und Entwicklerin seitens des Auftragnehmers ist die Gruppe 3 Frau Madeleine Wegmann. Sie übernimmt die Verantwortung für alle Phasen des Projekts und ist auch die Ansprechperson zum Autraggeber.
Kunden dieses Projektes sind beliebige Internet User.

1.5. Projektschnittstellen

Das Projekt ist in sich geschlossen, d.h. die komplette Erstellung und Dokumentation der Webanwendung wird im Rahmen dieses Projekts durchgeführt.
Der Auftraggeber liefert zum gegebenen Zeitpunkt Teile (HTML Templates, Persistenz...) der Applikation.
Seitens der Auftragnehmes soll das Design und die Implementation eines FormHandling Frameworks erstellt werden. Die vom Autraggeber gelieferten Teile der Applikation müssen in das Projekt integriert werden. Das Framework soll auch in anderen Projekten verwendet werden können.

1.6. Ansatz für das zu entwickelnde FormHandling Framework

Form Handling Framework

2. Projektplanung

Die gesamte Projektplanung wird in einem separaten Dokument beschrieben (siehe goto Projektplanung). Sie beinhaltet: die Zeit- und Ablaufplanung, Ressourcen- und Kostenplanung. goto Zeitplan und Meilensteine wurden zusätzlich auch in einem separaten Dokument aufbereitet.



3. Kick off

Die Kick off Phase wird in einem separaten Dokument beschrieben (siehe goto Kick off).

Phase
Ergebnis
Milestone
Termin
Aufwand
min.
Aufwand
max
Kick off
Projektplan
Phasenmodell
Hauptziel
Phasenmodell, Projektziel
 
10
13



4. Fachkonzept (Anforderungsspezifikationen)

Das Fachkonzept (Anforderungsspezifikationen) wird in einem separaten Dokument beschrieben (siehe gotoFachkonzept ). Es beschreibt die Anforderungen des Auftraggebers an die Webanwendung aus Sicht des Anwenders. In den Anforderungsspezifikationen wird unter anderem folgendes definiert:

Phase
Ergebnis
Milestone
Termin
Aufwand
min.
Aufwand
max
Analyse
*Anforderungsspezifikationen mit Rollen und USE Cases (Anwendungsfälle)
*Akteure, Rollen und ihre Rechte
*funktionale Anforderungen
Nicht funktionale Anforderungen
Anforderungsspezifikationen
Review durch den Auftraggeber
13.08.04
17
20



5. Systemdokumentation

Das Systemdokumentation wird in einem separaten Dokument geführt (siehe goto Systemdokumentation). Sie beinhaltet das Technische Konzept (Beschreibung der Systemeinordnung, Definition der Systemkomponenten und technischen Schnittstellen, Beschreibung der Datenstruktur und der wichtigsten Bausteine der Applikation (siehe goto Technisches Konzept). Das Systemdokumentation beinhaltet die folgenden Projekt Phasen:
Phase
Ergebnis
Milestone
Termin
Aufwand
min.
Aufwand
max
Design Systemdesign mit Architektur, Komponenten, Frameworks
*Klassendiagramm des zu implementierenden Teilaspekts
Sequenzdiagramm einer ausgewählten Aktivität
*Organisation der Datenbank mit Tabellen und Views
Organisation der Files (XML und Konfiguration)
*State Diagramm der Benutzeroberfläche, Screenflow
Dokumentation Technische Spezifikationen

Review durch Auftraggeber
17.09.04
24
48
Implementation *Verzeichnis- und Package Struktur des Codes
*Java Code mit Kommentaren wo sinnvoll
*Javadoc mit dokumentierten Klassen
Java Source Code des zu implementierenden
Teilaspekts  inkl. Dokumentation

Review durch Auftraggeber
15.11.04
40
80
Integration Dokumentation der Konfigurationsfiles
SQL Script für die Erstellung der DB
ANT Script für build / Deployment des Projekts
Abnahme Dokument

Integration aller Module
30.11.04
16
32
Test, Debugging
Test- und Fehlerprotokoll Abgabe der getesteten Applikation 10.12.04
16
32