Protokoll - Projektgruppentreffen 21.03.2001 -------------------------------------------- Protokollanten: Jens Hanisch, Jens Klier 1. Dokumentation dynamischer Ablaeufe: S. Berndt, J. Ullrich: UML - Interaktionsdiagramme - Probleme mit: - umfangreichen Quelltext - verteilt auf mehrere Dateien - durch OO stark verschachtelt (starke Interaktionen zwischen Objekten) - Lösung: - zum Einarbeiten / Verstehen des Codes wurde Wesentliches extrahiert und handschriftlich auf 2 Blatt dargestellt - Verwendung von Interaktionsdiagrammen (UML) zur Darstellung dynamischer Aspekte (gut geeignet für Forward- und Reverse-Engeneering) - Vorstellung von: - Sequenzdiagrammen zur Darstellung zeitlicher Reihenfolgen von Nachrichten -> zeitlicher Ablauf steht hier im Vordergrund - Kollaborationsdiagrammen zur Darstellung der strukturellen Organisation der Objekte, die Nachrichten senden / empfangen -> Objekte stehen hier im Vordergrund - beide Diagrammformen sind semantisch äquivalent, (d.h. Transformation ohne Informationsverlusten möglich) aber Sequenzdiagramm für diesen Anwendungsfall besser geeignet! - es existieren Programme zur Erstellung solcher Diagramme (RationalRose...) - aber Probleme: - sehr umfangreich -> was weglassen? - Behandlung von Nachrichtenaustausch mit globalen Funktionen und Windows-API schwer, da Diagramme stark objektorientiert - Lösungsvorschlag: - Erweiterung der Interaktionsdiagramme, in der globale Funktionen und API-Funktionen als Objekte betrachtet werden - keine Einwände gegen diesen Vorschlag - aktueller Stand und Abschätzung: - momentan wird ein (evt. sehr großes) Diagramm für den Scanner fertiggestellt - dabei Konzentration auf das Wesentliche - Vorschlag U. Sacklowski: Verkürzung des Diagramms durch kommentierte Schnitte - Gegenargument: Funktionsaufrufe sind schon aussagekräftig und kurz genug - ca. 1 Monat Zeitaufwand - Frage: Wie wird Fallunterscheidung behandelt ? Lösung: Noch nicht vollendet, evt. mehrere Diagramme für verschiedene Fälle 2. Benutzerdokumentaion und Online-Hilfe (U. Sacklowski) - Vorstellung einer Gliederung - Diskussion - neu: X.Benutzerhandbücher -> welche... - es gibt 2 Arten: 1. Online-Hilfe (wenig Aufwand, da wenig Wartung) 2. Benutzer-Handbücher nach Balzert - dabei unterscheidet Balzert: - Trainingsbücher - Referenzbücher - Referenzlisten - Benutzer-Leitfäden - unser Schwerpunkt liegt auf Benutzer-Leitfäden ! - besser kleine (kurze) Dokumentationen ! - es soll 1 (2?) Installationshandbücher und mehrere Leitfäden geben - es gibt Leitfäden mit modularer oder hierarchischer Gliederung - modulare Leitfäden behandeln atomare oder zusammengesetzte Basisanwendungen - für jede Basisanwendung ensteht ein Benutzer-Leitfaden nach Balzerts Gliederung - hierarchische Leitfäden behadeln Gesamtvorgänge (bei Balzert nicht erwähnt) - neu: IX.Entwicklerdokumente: - Problem Englisch vs. Deutsch - Einstellung der Sprache bei Installation oder Compilation ? - K. Schützler: eigentlich im CVS-Repository #ifdef GERMAN_VERSION daher kein Problem ! - darauf achten, dass sowohl deutsche, als auch englische Versionen vorhanden ! - Vorschlag U. Sacklowski: deutschsprachige Abbildungen in Benutzer-Leitfäden englischsprachige Abbildungen in den Anhang - außerdem Online-Hilfe nur in deutsch ! -> besser für Copy&Paste - zurück zu X.Benutzerhandbücher: - Vorstellung der Gliederung der Benutzer-Leitfäden nach Balzert - Problem bei häufig verwendeten Abbildungen Lösung durch Verweise oder Anhang - Dokumentation von Gesamtvorgängen ist Mischung aus manuellen Vorgängen und Dialogvorgängen -> dazu Anleitung im Web (hier nicht besprochen) - Frage nach dem Format: (X.Benutzerhandbücher -> Formate...) - Vorschlag U. Sacklowski: zentrales Format Word97 ohne Makros und automatische Funktionen - Frage K. Schützler: Verwendung von LaTeX mit WYSIWYG-Editor ? - Vorschlag U. Sacklowski: Word97-Dokumente auch als pdf-Dokument für langsame Modemverbindungen anbieten - Online-Hilfe - Vorstellung des Aufbaus der Online-Hilfe: - zwei Einstiegspunkte --> über Menü-Funktionen --> über Dialog- und Meßfenster - Darstellung der Dialogboxen - Funktionen - Felder und Schalter - Diskussion - sind zwei Dokumentationen notwendig? - in der Online-Hilfe ist sind Verweise auf dir entsprechenden Basisanwendungen der Benutzerleitfäden notwendig - Vorstellung des Programms HelpScribble zur Erstellung der Online-Hilfe --> siehe Entwicklerdokumente - Verantwortlicher für die Absprache der vorgeschlagenen Dokumentationen mit der Physik festgelegt (Herr Buss) 3. Use Case-Diagramme: Vergleich der beiden bei uns auf den Web-Seiten veroeffentlichten Versionen (Diskussionsgrundlage: K. Bothe) (Anm.: Hier waere es guenstig, wenn sich jeder vorab die Diagramme ansieht und sich eine Meinung bildet) 4. Information zu den Tagungen SEUH (Zuerich) und CSEET (Charlotte) (U. Sacklowski, K. Bothe) - 3. und 4. Tagesordnungspunkt wurden auf die nächste Veranstaltung verschoben 5. Kurzer Bericht der einzelnen Gruppen zu den laufenden Arbeiten - Herr Müller: - Portierung des Programms nach Visual C++ ist fehlgeschlagen - Aufgabe ist jetzt die Analyse des Portierungsversuches - Herr Schützler: - Zerlegung bzw. Abtrennung der Topographie ist in Arbeit - Herr Klier: - ini-File-Analyse und -Zerlegung ist in Arbeit - alle anderen Gruppen nichts neues nächster Termin: 26.04.01 15.00 Uhr