 |
|||
| HSG |
|
mk, Stand: 11.5.03
Dieses Dokument dient als Vorlage für die Dokumentation. Bei der Benutzung wird man die kursiv gedruckten Texte entfernen und fortlaufend durch eigene ersetzen.
Die Dokumentation soll fortlaufend in HTML geführt werden und zeigt die Ernsthaftigkeit und Systematik des Vorgehens. Die Dokumentation soll alle Informationen, die für das Projekt relevant sind, integrieren. Hierzu gehören Dateien von UML-Werkzeugen (UMLEd,Violet,..), die zugehörigen Bilder (*.gif, *.jpg, nicht vergessen, große Zwischendateien z.B. *.bmp zu löschen), Struktogramme, Literaturhinweise (Fundstellen), Quelltexte (Delphi-Projekte als downloadbare *.zip-Dateien einbinden, vor dem Packen alles Entbehrbare z.B. *.exe löschen, das Arbeiten an den Quelltexte geschieht wohl besser in einem von der Dokumentation getrennten Ordner), Testdaten
Hier stehen die Namen der Bearbeiter und das aktuelle Datum. Es wird im Allgemeinen sinnvoll sein, ein Backup der Datei zu führen.
/2/ ....
Hier wird die Teilaufgabe präzise beschrieben.
/4/ ....
Oft wird es nützlich sein, "innerbetriebliche" ("innerunterrichtliche") Vorgaben zu machen.
Ebenso geschieht hier die Auswahl beziehungsweise die Konstruktion der benötigten Algorithmen. Die Algorithmen werden durch Angabe der Fundstellen und/oder durch Struktogramme dokumentiert.
Ein Design im Hinblick auf besondere Möglichkeiten einer Programmiersprache ist zu vermeiden. Übertragbarkeit ist wichtiger als Eleganz der Einzellösung.
Teile des Quelltextes wird man häufig zur Darstellung von Einzellösungen zitieren und mit Text kommentieren. Quelltext soll mit beigem Hintergrund und eventuellen farblichen Hervorhebungen dargestellt werden.
Dieses Dokument dient als Vorlage für die Dokumentation. Bei der Benutzung wird man die kursiv gedruckten Texte entfernen und fortlaufend durch eigene ersetzen.
Die Dokumentation soll fortlaufend in HTML geführt werden und zeigt die Ernsthaftigkeit und Systematik des Vorgehens. Die Dokumentation soll alle Informationen, die für das Projekt relevant sind, integrieren. Hierzu gehören Dateien von UML-Werkzeugen (UMLEd,Violet,..), die zugehörigen Bilder (*.gif, *.jpg, nicht vergessen, große Zwischendateien z.B. *.bmp zu löschen), Struktogramme, Literaturhinweise (Fundstellen), Quelltexte (Delphi-Projekte als downloadbare *.zip-Dateien einbinden, vor dem Packen alles Entbehrbare z.B. *.exe löschen, das Arbeiten an den Quelltexte geschieht wohl besser in einem von der Dokumentation getrennten Ordner), Testdaten
Titel des Projekts
Gruppe: Hanni und Nanni, 7.5.03Hier stehen die Namen der Bearbeiter und das aktuelle Datum. Es wird im Allgemeinen sinnvoll sein, ein Backup der Datei zu führen.
Aufgabenstellung
Hier steht die oft noch sehr allgemeine Aufgabenstellung.Systemanalyse
Hier stehen Informationen (z.B. Internet-Links, Literaturverweise, Bilder, Texte), die das Verständnis der Aufgabenstellung fördern.Teilziele
Es wird sehr häufig günstig sein, die Aufgabenstellung in einzeln erstell- und testbare (sogenannte "Testfälle") Teilziele zu zerlegen.Pflichtenheft zur 1.Teilaufgabe
/1/ ..../2/ ....
Hier wird die Teilaufgabe präzise beschrieben.
"interne Pflichten":
/3/ ..../4/ ....
Oft wird es nützlich sein, "innerbetriebliche" ("innerunterrichtliche") Vorgaben zu machen.
Prototyp
Hier steht ein Muster für die Benutzeroberfläche des zu erstellenden Informatiksystems. Dieses Muster wird oft bereits mit der später benutzen Entwicklungsumgebung erstellt. Um einen Prototyp zu erstellen, sind Gedanken über Eingaben und Ausgaben nötig. Wie die Verarbeitung geschieht, ist hier kein Thema.Objektorientierte Analyse
Hier wird die Aufgabenstellung durch verschiedene UML-Diagramme zusammen mit erläuterndem Text aus unterschiedlichen Blickwinkeln dargestellt und im Detail präzisiert. Die Abgrenzung zum objektorientierten Design geschieht durch die Frage nach "Was" und "Wie". Die objektorientierte Analyse steht am Ende des "Was", das objektorientierte Design am Anfang des "Wie".Anwendungsfalldiagramm
Zustandsautomat
Objektorientiertes Design
Hier wird man die Objekte in ihrer Hierarchie und ihrem Zusammenspiel festlegen. Das Ergebnis der Festlegungen wird in UML-Diagrammen dargestellt.Ebenso geschieht hier die Auswahl beziehungsweise die Konstruktion der benötigten Algorithmen. Die Algorithmen werden durch Angabe der Fundstellen und/oder durch Struktogramme dokumentiert.
Ein Design im Hinblick auf besondere Möglichkeiten einer Programmiersprache ist zu vermeiden. Übertragbarkeit ist wichtiger als Eleganz der Einzellösung.
Klassendiagramm
Kollaborationsdiagramm
Packagediagramm
Implementierung
Erst ab hier spielt die gewählte Programmiersprache eine Rolle. Hier wird der Quelltext in *.zip-Archiven zum Download angeboten.Teile des Quelltextes wird man häufig zur Darstellung von Einzellösungen zitieren und mit Text kommentieren. Quelltext soll mit beigem Hintergrund und eventuellen farblichen Hervorhebungen dargestellt werden.
type TZustand = (rot,rotgelb,gruen,gelb); |