Technische Dokumentation

Transkript

1 Technische Dokumentation Projektgruppe : Projektname: YOLO Stats.Keeper Projektmanager Chefdesigner Entwickler Dokumentationsmanager Waldemar Belikow Wojchiech Lesnianski Fatih Emin Sahin Alexander Kosares IT2B Softwaretechnik IT2B Softwaretechnik IT2B Tech. Informatik IT2B Softwaretechnik Im Rahmen der Informatik II Vorlesung sollte ein Projekt entwickelt werden. Die Gruppe YOLO entschloss sich, Stats.Keeper zu entwickeln. Es ist eine Fußball-Liga-Verwaltungssoftware die realisiert worden ist

2 Inhaltsangabe Informatik Projekt: Staats Keeper... 3 Erste Ideen zum Projektantrag Verteilung der sekundären Aufgaben einzelner Mitglieder Erste Ansätze und Umsetzungen Festlegung der Module und Aufgaben einzelner Mitglieder Vorbereitung zur ersten Projektpräsentation (Teil 1) Vorbereitung zur ersten Projektpräsentation (Teil 2) Vorbereitung zur zweiten Projektpräsentation Erstellung der Website stats-keeper.de Bedienungsanleitung Testen

3 Informatik Projekt: Staats Keeper Erste Ideen zum Projektantrag Es sollte eine Software entwickelt werden die Fußball Fans die Möglichkeit bietet ihre persönlich ausgewählten Ligen zu verwalten. Dabei kann der User mittels Software Mannschaften einer vorzugsweise existierenden Liga eintragen/auswählen um durch das registrieren von Ergebnissen zu den jeweiligen Spieltagen eine von Staats Keeper ausgewertete Liga Tabelle zu erhalten. Verteilung der sekundären Aufgaben einzelner Mitglieder Da das Projekt nicht nur aus Programmierarbeit besteht mussten weitere (nicht Programmierbezogene) Verpflichtungen wie folgt verteilt werden: Waldemar Belikow: Projektmanager Wojchiech Lesnianski: Chefdesigner Fatih Emin Sahin: Entwickler Alexander Kosares: Dokumentationsmanager Erste Ansätze und Umsetzungen Zur Anschauung wie die Software in ihre Umgebung und deren Schnittstellen eingebunden wird, wurde ein Kontextdiagramm entworfen: Des Weiteren wurde die Visualität der Programmfenster durch Skizzen erarbeitet. Dabei sollten Ideen zur grafischen Umsetzung und Funktionalität der Software erstmals zu Papier gebracht werden um Überblick über die GUI zu erhalten. Genaueres zum Prototyp der grafischen Oberfläche kann man der Design Dokumentation entnehmen

4 Festlegung der Module und Aufgaben einzelner Mitglieder Zur Übersicht der Module und deren Datenaustausch wurde ein Moduldiagramm (siehe Design Dokumentation) entworfen. Außerdem wurde die Modulverteilung festgelegt: Wojchiech Lesnianski: GUI, Eingabe Waldemar Belikov: Datenhaltung Fatih Emin Sahin: Speichern/Laden, Sortieren Vorbereitung zur ersten Projektpräsentation (Teil 1) Für die erste Projektpräsentation musste ein Pflichtenheft erstellt werden. Mehr zum Pflichtenheft kann man im Anhang Pflichtenheft finden. Des Weiteren wurde ein Terminplan (siehe Anhang Terminplan) erstellt. Außerdem musste ein Anforderungskatalog entworfen werden. Hier einige Ansätze über die Anforderungen von Stats.Keeper. Liga anlegen Liga Name festlegen Teamanzahl festlegen (nicht mehr als 26) Auf/abstiegsplätze sowie Relegationsplätze festlegen Mannschaften eintragen Spieltag auswählen (Anzahl der Spieltage wird aus der Teamanzahl errechnet) Ergebnisse eintragen Ergebnisverwaltung Ligatabelle ausgeben Sortieroption Abspeichern/laden Selbstverständlich soll das Programm den User auf ungültige Eingaben mittels Fehlermeldungen hinweisen. Das gesamte Programm inklusive der GUI wird in C geschrieben. Vorbereitung zur ersten Projektpräsentation (Teil 2) Nach dem die Grundlegenden Sachen für die Projektpräsentation getätigt wurden, musste sich um die eigentliche PowerPoint Präsentation gekümmert werden. Dabei wurden die bisher erarbeiteten Tätigkeiten verfeinert und Präsentationsfähig gemacht. Die Projektpräsentation kann man natürlich downloaden um näheres zu erfahren

5 Vorbereitung zur zweiten Projektpräsentation In der zweiten Projektpräsentation musste das Programmdesign vorgeführt werden. Somit wurde die Programmierung der GUI in Gang genommen und es musste gemeinsam ein Operationsdiagramm entworfen werden. Anschließend wurden Programmierrichtlinien festgelegt. Hier eine Liste der einzuhaltenden Programmierrichtlinien: jegliche Funktionen werden mit Kommentaren versehen und müssen in der Headern ausführlich beschrieben werden alle Kommentare und Anmerkungen sind deutsch Variablen werden mit aussagekräftigen und verständlichen Namen deklariert Laufvariablen werden durch i und j deklariert alle Blöcke werden per Tabulator eingerückt Set und Get Methoden in der Datenhaltung Selbstverständlich wurden diese Informationen in die PowerPoint Präsentation bzw. die jeweiligen Dokumentationsabschnitten gepackt wo sich genauer beschrieben werden. Anfang der Programmierarbeit Zunächst wurde die GUI programmiert. Anschließend übernahm jedes Mitglied die Programmierung des ihm zugehörigen Moduls. Näheres zur Programmierarbeit wird in anderen Teilabschnitten der Dokumentation beschrieben. Erstellung der Website stats-keeper.de Die Webseite wurde mit CSS und HTML entworfen und sämtliche Grafiken mit Photoshop erstellt. Es wurde besonderen Wert auf Übersichtlichkeit und einfaches zurechtfinden gelegt und dementsprechend implementiert. Damit bei Suchmaschinen wie Google unsere Webseite möglichst oben aufgelistet wird, wurden Optimierungen der Webseite für Rankings durchgeführt. Somit erscheint bei der Eingabe von Stats.Keeper unsere Webseite auf der 2. Seite von Die Webseite beinhaltet sämtliche Dokumente zum Download und Softwareversionen von der Alpha Version bis hin zu Final Edition von Stats.Keeper. Eine kurze Bedienungsanleitung sowie Beschreibung des Projekts ist ebenfalls aufzufinden. Ein Gästebuch umschließt die Webseite und ermöglicht ein Feedback der User zu bekommen. Bedienungsanleitung dazu siehe Anhang Bedienungsanleitung Testen Nach Abschluss der Programmierarbeiten musste die Software auf Fehler überprüft werden. Näheres dazu in der Testdokumentation