doku/handbuch

Diese Seite soll das Benutzerhandbuch zum Use Case Editor darstellen. Die Dokumentation ist nicht aktuell, beschreibt aber die wichtigsten Funktionen. Der Screenshot bezieht sich im Gegensatz zum Text auf die aktuelle Version. Wenn irgendwelche Ungereimtheiten auftreten, bitte ich um Kommentare hier in der Seite, damit alle Nutzer und Entwickler davon profitieren können. Entwickler von neuen Erweiterungen bitte ich, hier ihre Dokumentation einzupflegen. Nutzer bitte ich, ihre Erfahrungen, Tipps und Anmerkungen hier einzutragen!

Installationsanleitung

Wenn Sie Java 6 installiert haben*, müssen Sie das Archiv einfach nur auf Ihrer Festplatte entpacken (z.B. nach c:\Programme\usecaseeditor). Direkt im Basisverzeichnis finden Sie eine .jar Datei - usecasedode.jar. Die sollte unter Windows einfach per Doppelclick ausführbar sein. Verknüpfung ins Startmenü unter Windows: Rechte Maustaste auf den Start-Button, "Öffnen - Alle Benutzer", in den Ordner "Programme" gehen, die Jar-Datei mit der rechten Maustaste in den Ordner ziehen und "Verknüpfung hierher erstellen" aus dem Kontextmenü wählen. Ausführen auf der Kommandozeile: Gehen Sie in das entsprechende Verzeichnis und geben Sie den Befehl "java -jar usecasedode.jar" ein.

* Auch wenn die Screenshots im Wiki z.T. OS X zeigen, gibt es Java 6 derzeit nur in einer Preview-Version für OS X 10.4 Tiger (nicht Leopard). Diese wurde mit dem Release von Leopard bis zum Release der offiziellen Java-6-VM zurückgenommen, ist aber noch auf einigen Mirrors verfügbar, Link z.B. unter  http://discussions.apple.com/thread.jspa?threadID=1132446&tstart=0 — damit ist zumindest eine kriechend langsame Ausführung vom SE HERA-RE-DODE-Editor-Toolprogramm möglich. Auf Macs, auf denen der Rechtsklick noch über Strg-Klick durchgeführt wird, kann man ohne externe Maus zudem keine Use Cases löschen und damit auch nicht verlinken, weil das Kontextmenü fehlt. Aber ich glaube, es gibt eh in jedem Team mindestens einen PC ;)

Use Case Editor: Benutzereinführung

FIXME [TODO]: Auf aktuellen Stand bringen!

Das ist die Anleitung von Christian Crisp.

Ansprechpartner: Eric Knauss, FG Software Engineering, Leibniz Universität Hannover
Email: eric.knauss@…

Die Oberfläche des Use Case Editors besteht aus verschiedenen Bereichen. Im Zentrum findet die Bearbeitung eines geöffneten Use Cases statt. Im oberen rechten Bereich ist eine grafische Visualisierung des aktuellen Use Cases zu sehen. Der Assistent gibt im unteren rechten Bereich Hilfestellungen und erklärt verschiedene Probleme. Eine Zusammenfassung aller Probleme ist im ProblemView direkt unter der Konstruktion zu finden. Alle Bereiche, also auch der Assistent und die ProblemView lassen sich auf Wunsch ausblenden.

Abbildung 1: Die Grafische Benutzeroberfläche

Der Projektbaum

Im Projektbaum können Use Cases durch Auswählen zur Bearbeitung geöffnet werden. Es öffnet sich ein Formular bzw. das bereits geöffnete Formular wird mit den Daten des ausgewählten Use Cases ausgefüllt. Mit dem Auswählen eines Attributs lässt sich direkt zum Attribut springen, dabei wird das Formular automatisch gescrollt. Mit der rechten Mautaste lassen sich neue Use Cases anlegen bzw. bestehende löschen. Auch das Sortieren ist möglich. Dazu kann zwischen den Attributen „Use Case ID“, „Titel“, „Ebene“, „Status“ und „Priorität“ gewählt werden, wobei die ersten beiden alphanumerisch sortiert werden, die übrigen nach der Reihenfolge der auswählbaren Werte im Formular. Im Projektbaum erfolgt auch die Markierung von fehlerhaften Use Cases bzw. Attribute. Dazu werden ähnlich wie in Eclipse ([Ecl06]) entsprechende Icons an den Knoten gesetzt und zwar so, dass zum Fehler navigiert werden kann.

Das Formular

Die Bearbeitung des Use Cases erfolgt in einen Formular. Dazu werden die zuvor geschriebenen Werte geladen und angezeigt. Der Benutzer kann bestehende Texte frei editieren und im Falle eines Auswahlfeldes eine andere Option auswählen. Die Stakeholder, Szenarios, sowie die Variationen werden in einer Tabelle dargestellt. Über die Buttons auf der rechten Seite kann der Benutzer weitere Akteure, Schritte bzw. Variationen einfügen, löschen, oder verschieben. Des Weiteren lässt sich im Falle des Hauptszenarios ein bzw. mehrere Schritte erweitern (auf zu erweiternden Schritt Button drücken), oder ein Use Case verlinken (auf zu erweiternden Schritt Button drücken). Durch Drücken der Shift-Taste und anklicken eines eingebundenen Use Case kann man zum verlinkten Use Case springen.

}}

Auf Grund der Übersichtlichkeit lassen sich sie die Erweiterungen ein- und ausklappen. Im ersten Feld wird der referenzierte Schritt angegeben und im darauf folgenden Feld lässt sich die Bedingung angeben. Es kann ein Szenario angegeben werden, wenn die Erweiterung ausgeklappt ist. Eine Erweiterung lässt sich durch das Icon neben der Bedingung entfernen. Eine weitere Besonderheit stellen die Dateianhänge dar. Beim Hinzufügen eines Dateianhanges wird die ausgewählte Datei in einen Ordner kopiert. Dieser Ordner befindet sich im gleichen wie die Projektdatei und trägt den gleichen Namen dieser Datei gefolgt von einem „_attachments“. Beim Kopieren des Projekts auf einen anderen Datenträger, muss dieser mitkopiert werden, da die Dateianhänge sonst verloren gehen. Die Dateianhänge lassen sich durch gedrückter Shift-Taste und anklicken des Anhangs direkt öffnen (Vorraussetzung ist Windows XP). Auch im Formular werden Fehler und Warnungen durch entsprechende Icons an den Attributen angezeigt.

Overview

Im so genannten Overview wird der Use Case grafisch dargestellt. Dazu werden auch die verlinkte Use Cases angezeigt, die durch einen Doppelklick geöffnet werden können.

Das hier angezeigte Use Case Diagramm ist nicht ganz UML-Konform. Zudem soll es auch nur den Kontext des gerade bearbeiteten Use Cases zeigen. Als Überblicksbild in der Anforderungsspezifikation sind diese Diagramme nicht geeignet - auch wenn sie sich über das Menu exportieren lassen.

Assistent

Der Assistent zeigt je nach Kontext die entsprechenden Hilfestellungen, Warnungen und Fehler an. Bearbeitet man beispielsweise gerade den Titel, so werden nur Erfahrungen angezeigt, die dazu nützlich sein könnten. Der Assistent zeigt nur einen Teaser an. Möchte man mehr wissen, muss man auf den entsprechenden Link drücken. Der Assistent erläutert daraufhin die Erfahrung ausführlicher und gibt gegebenenfalls Hilfestellungen, die beim Lösen des Problems helfen sollen. Ist der Benutzer mit der Erfahrung nicht einverstanden bzw. hat selbst Erfahrungen gemacht, so kann er die bestehende Erfahrung kommentieren. Dazu kann er eine Kurzbeschreibung und eine ausführliche Erläuterung eingeben. Diese werden dann unter der bestehenden angezeigt. Sollte eine Erfahrung nicht nützlich sein, so hat der Benutzer die Möglichkeit, diese für einen Use Case oder für alle Fälle zu ignorieren. Eventuell gibt es mehrere Erfahrungen. Daher kann er durch die entsprechen Buttons unter der Anzeige zur der nächsten springen bzw. wieder zurück navigieren.

Die ProblemView

Die Problemsicht fasst alle Probleme im Projekt zusammen. Der Benutzer kann durch die Kurzbeschreibung erkennen, um was für ein Problem es sich handelt und durch Angabe des Use Cases und des Attributes wo der Fehler ist. Durch einen Doppelklick kann er direkt zum Fehler springen. Durch Anklicken der Spaltennamen können die Kritiken nach Art (Fehler/Warnung?), Kurzbeschreibung, Use Case oder Attributname sortiert werden.

Das Menu

Im Datei-Menu kann der Benutzer ein neues Projekt anlegen, ein Projekt laden, oder ein geöffnetes speichern.

Export

Auch das Exportieren ist möglich, wobei zunächst die gewünschten Use Cases und dann ein Format ausgewählt werden kann. Derzeit wird HTML (zum Beispiel zum Einfügen in Word oder OpenOffice) und LaTeX unterstützt.

Das Use Case Diagramm in der grafischen Übersicht kann als Bild im JPEG-Format exportiert werden.

Das Glossar-Plugin

Das Glossar-Plugin bietet dem Benutzer die Möglichkeit während der Erstellung von Anforderungen ein Glossar anzulegen.

Hierzu wird eine Liste mit Vorschlägen im oberen rechten Bereich des Editor geführt.

Die hier aufgeführten Vorschläge sind nach Vorkommenshäufigkeit geordnet und können per Klick in das Glossar übernommen werden.

Zusätzlich können Einträge auch über das Kontextmenü der Textfelder oder über den Projektbaum hinzugefügt werden.

Im Glossar aufgenommene Wörter werden in den Eingabefeldern durch eine blaue Wellenlinie markiert. Per Rechtsklick kann zum entsprechenden Glossareintrag gewechselt werden.

Filtern der Vorschlagsliste

Da die Vorschlagsliste evtl. auch Einträge enthalten kann, die nicht für die Aufnahme in ein Glossar gedacht sind, kann sie mit Filtern angepasst werden.

Ein einfache Möglichkeit einen Vorschlag zu ignorieren bietet der Link "Ignorieren" hinter dem Vorschlag. Hierdurch wird das betreffende Wort nicht mehr angezeigt.

Für weiter Filter führt ein Klick auf den Link "filtern" zur Filterverwaltung.

Aktivierte Filter sind entsprechend markiert. Durch einen Klick auf den entsprechenden Filter wird dieser aktiviert bzw. deaktiviert.

Für neue Filter oder die Bearbeitung existierender steht der folgende Dialog zur Verfügung:

Hier kann der Filtername sowie dessen Wirkungsweise eingestellt werden.

Außerdem kann eine beliebige Menge regulärer Ausdrücke mit Angaben zur Vorkommeshäufigkeit eingegeben werden.

Attachments