Pflichtenheft Master Thesis Von Swing zu Ergonomie

Transkript

1 Pflichtenheft Master Thesis Von Swing zu Ergonomie Nummer der Abschlussarbeit MAS Klasse / Datum MAS-IT / Student und Autor Betreuer Expertin Emilio Walter Jurastrasse 41 CH-3063 Ittigen emiliowalter@hispeed.ch Jan van Hoeck Flexor AG Untermüli 6 CH-6300 Zug Dr. Beatrice Amrhein Berner Fachhochschule Wankdorffeldstrasse 102 CH-3014 Bern beatrice.amrhein@bfh.ch Abstract Erstellung eines Buches, welches die Lücke zwischen Programmierung und Ergonomie schliesst. Wie der Programmierer sein Wissen einsetzen soll, um aus den vielen, einzeln erlernten Techniken zu ansprechenden und den Ergonomieansprüchen gerecht werdenden Masken zu gelangen. Schlüsselwörter: Ergonomie, Swing, Anleitung, Buch

2 Inhaltsverzeichnis 1 Einleitung Änderungen an diesem Dokument Ziel Motivation Zielpublikum Rahmenbedingungen Abgrenzung Anforderungen Buchstruktur Vorwort und Einleitung Teil I Software Ergonomie Standards Blick über den Tellerrand Eins oder mehrere gute Beispiele Eins oder mehrere schlechte Beispiele Eins oder mehrere katastrophale Beispiele Teil II Ergonomie mit Swing Themen Teil III Design Patterns und Ergonomie Aufzuführende Patterns Anhang Glossar Anhang Literaturverzeichnis Anhang Abbildungsverzeichnis Index UML Diagramme Buchentwurf Abbildungen Deliverables Buch Source Code der Beispiele Planung 12 2

3 1 Einleitung 1.1 Änderungen an diesem Dokument Anforderung 2.11 Buchdruck Qualität wird zu Buchentwurf Dokument erstellt 1.2 Ziel Erstellung eines Buches, welches die Lücke zwischen Programmierung und Ergonomie schliesst. Wie der Software-Entwickler sein Wissen einsetzen soll, um aus den vielen, einzeln erlernten Techniken zu ansprechenden und den Ergonomieansprüchen gerecht werdenden Masken zu gelangen. 1.3 Motivation Es gibt so viele gute Software-Entwickler da draussen, junge und auch erfahrene. Die meisten haben über Jahre die Schulbank gedrückt, um zu tun, was sie tun. Sie sind Software-Engineer, Software-Architekt, Analyst und Designer geworden. Sie haben alles Wissenswerte und Renomierte über Programmieren und Software Ergonomie gelesen. Und trotzdem gibt es immer wieder neue Software, welche den Benutzer eher behindert als ihm zu helfen. Wie kann das sein? Nachdem ich nun selbst bald mit dem Studium fertig bin, habe ich mir folgende Erklärung zusammengereimt: Entweder ist die bereits existierende Fachliteratur zu kompliziert geschrieben oder es fehlt einfach der Übergang, das Verbindungsstück zwischen Theorie und Praxis. Dieses Buch soll helfen diese Lücke zu schliessen. 3

4 1 Einleitung 1.4 Zielpublikum Das Buch richtet sich an etablierte und zukünftige Software Entwickler. Es ist für Selbststudium und als Begleitliteratur zu Vorlesungen auf Ebene Fachhochschule gedacht. Es soll helfen die in unterschiedlichen Vorlesungen wie Analyse und Design, Software Ergonomie oder Programmierung in Java erarbeiteten Informationen zu einer Masse zu verkitten. Die vielen praktischen Beispiele und Bilder sollen die eher nüchtern geratenen Fachbücher ergänzen, um ein breiteres Spektrum an persönlichen Arten zu Lernen abzudecken. Für den ersten Teil des Buches, die Erklärungen zu den Software Ergonomie Standards, bedarf es keiner speziellen Vorkenntnisse. Dieser Teil eignet sich für alle Software - Technik interessierten Leser. Für den zweiten und dritten Teil des Buches braucht es mindestens Kenntnisse in der Java Swing Programmierung. Noch mehr profitiert der Leser, wenn er schon Erfahrungen mit dem Programmieren in Swing gemacht hat. Für das Verständnis der Diagramme im zweiten und dritten Teil des Buches, braucht es zudem rudimentäre Kenntnisse der Analyse und Design Sprache UML. 1.5 Rahmenbedingungen im Zeitrahmen der Master Thesis zu erstellen vom bis der Aufwand soll sich auf mindestens 360 Stunden erstrecken mindestens 150 Seiten, maximal 350 Seiten bereit zum Einsenden an Verlag 1.6 Abgrenzung Folgende Arbeiten gehören zwar zum Projekt, werden jedoch aus Zeitgründen erst nach dem Abgabetermin erledigt werden können und sollen somit nicht Bestandteil der Master Thesis sein: Suchen geeigneter Verlagshäuser Gestaltung Umschlag, inkl. Angaben zum Autor Anbieten des Buches an Verlage 4

5 2.1 Buchstruktur Das Buch besteht aus folgenden Teilen: Vorwort und Einleitung Teil I Software Ergonomie Standards Teil II Ergonomie mit Swing Teil III Design Patterns und Ergonomie Anhang mit Glossar, Literaturverzeichnis und Abbildungsverzeichnis Index 2.2 Vorwort und Einleitung Das Vorwort fasst in ein paar Absätzen Sinn und Zweck des Buches und die Motivation des Autors. Die Einleitung deckt folgende Themen ab: Für wen ist das Buch? Beschreibung wen das interessieren könnte und wen nicht. Benötigtes Wissen Was sind die Voraussetzungen um vom Buch zu profitieren? Buchstruktur Beschreibung der Teile. Symbole Verwendete Symbole, welche auf bemerkenswerte Stellen hinweisen. 5

6 2.3 Teil I Software Ergonomie Standards In diesem Teil des Buches werden die sieben wichtigsten Grundsätze der Software Ergonomie erklärt. Diese sieben tauchen immer wieder in der Fachliteratur auf. So auch in den ISO Standards Die Grundsätze werden mit Bildern und Text verständlich gemacht. Die zu erklärenden Grundsätze 1. Aufgabenangemessenheit 2. Selbstbeschreibungsfähigkeit 3. Steuerbarkeit 4. Erwartungskonformität 5. Fehlertoleranz 6. Individualisierbarkeit 7. Lernförderlichkeit Pro Ergonomie Standard gibt es dann noch eins bis vier Unterkapitel, welche anhand von Beispielen den Ergonomie Standard noch vertiefen. (Aufgeführt als bis 2.3.4) Blick über den Tellerrand In diesem Unterkapitel geht es um den Blick über den Tellerrand. Wie wird dieser Standard in der Praxis in anderen Fachgebieten umgesetzt? Dabei muss es nicht unbedingt um Software gehen. Ziel von diesem Unterkapitel ist es, den jeweiligen Ergonomie Standard begreiflich zu machen Eins oder mehrere gute Beispiele Beispiele von Bildschirmmasken, welche auf gelungene Weise einen oder gleich mehrere Ergonomie Standards umsetzen. Dazu Erklärungen, warum das nun besonders gut ist. Ziel von diesem Unterkapitel ist es, denn Leser über Vorbilder zu motivieren Eins oder mehrere schlechte Beispiele Beispiele von Bildschirmmasken, welche die Anforderung nicht optimal umsetzen. In diesem Unterkapitel sollen Fallstricke und Feinheiten aufgezeigt werden. Das Auge des Lesers soll trainiert werden Details auf Masken zu erkennen, welche die Software Ergonomie beeinflussen. 6

7 2.3.4 Eins oder mehrere katastrophale Beispiele Beispiele von völlig misslungenen Versuchen die Anforderungen umzusetzen. Dieses Unterkapitel soll zum Einen einen auflockernden Effekt haben, aber auch den Leser über den Weg von Humor im Unterbewussten treffen. Er soll auf die schlimmsten Fehler sensibilisiert werden. 2.4 Teil II Ergonomie mit Swing In diesem Teil des Buches werden Java Swing Lösungen zu verschiedenen Aspekten der Software Ergonomie gezeigt. Dabei geht es um Teilaspekte, die man beim Aufbau von Masken beachten muss, um ansprechendes und ergonomisches Design zu erhalten. Die verschiedenen Beispiele bestehen jeweils aus einem Kapitel. Dieses wird wiederum unterteilt in Unterkapitel mit folgenden Schwerpunkten: Beschreibung der Problemstellung Lösungsmöglichkeit auf abstrakter Ebene Konkrete Lösung mit Swing UML Diagramm der Lösung mit Erklärungen zu den Klassen Java Code dazu Diese Unterkapitel tragen jeweils dem Thema angepasste Titel, statt der Abstraktion aus der Aufzählung weiter oben. Das Ziel ist, dass der Leser über Beispiele und konkrete Beschreibungen erreicht wird. Werden bei der Lösung Design Patterns eingesetzt, wird explizit darauf hingewiesen Themen Folgende Themen werden im Buch behandelt: 1. Weniger ist mehr Die Grenze bestimmen bei der es keinen Sinn mehr macht, noch mehr auf die Maske zu packen. Die Anwendungsfälle nehmen als Basis für den Umfang pro Maske. 2. Die Datenbank gehört nicht auf den Bildschirm Die Trennung der Datenschicht von der Darstellung als Basis für ergonomisches Design. 3. So viele Optionen und so wenig Zeit Wie man mit komplexen Auswahlmöglichkeiten umgeht. 7

8 4. Wo bin ich? Was soll ich hier? Und was wollte ich gerade tun? Wie der Benutzer in komplexen Abläufen, die Übersicht behält. 5. Wo war doch das gleich? Was Gewohnheit mit Ergonomie zu tun hat und nach welchen Regeln die Menu- Einträge und Icons auf der Toolbar verteilt werden. 6. Nähe schafft Zusammenhang Wie beschriftet man Eingabefelder am besten? Auf was kommt es an? 7. Mal steht der Befehl zur Verfügung, mal nicht? Wie man die Konsistenz behält, wenn dieselben Befehle an verschiedenen Orten auftauchen. 8. Mal eben schnell die Farbe aller Fenster wechseln Corporate Designs mittels Look and Feel Klassen umsetzen. 9. Wenn das Grösste der Bildschirm ist Wie erlaubt man dem Benutzer Fenster-Grössen anzupassen und behält dabei ein ergonomisches Design? 10. Eingabe nicht korrekt! Der Situation angepasste Fehlermeldungen ausgeben. 11. Hilfe Wie implementiere ich kontext-sensitive Hilfe und was ist das überhaupt? 12. Wenn Profis und Anfänger dieselbe Maske verwenden Ein einzelnes Steuerelement für verschiedene Ansprüche gestalten. 2.5 Teil III Design Patterns und Ergonomie In diesem Teil des Buches werden alle 23 Pattern aus dem Buch Design Patterns 1 kurz, über je zwei bis vier Seiten, erklärt. Die Erklärungen sollen einen Überblick über die 23 Pattern verschaffen, wie sie im Zusammenhang mit Ergonomie Standards angewendet werden können. Dabei werden folgende Aspekte erläutert: Kurze Beschreibung des Patterns (1 bis 2 Absätze) Aufzählung des Nutzen und der Anwendungsgebiete Bezug zu Ergonomie Standards UML Diagramm der Struktur 1 Literaturhinweis: Gamma, Erich ; Helm, Richard ; Johnson, Ralph ; Vlissides, John: Design Patterns - Elements of Reusable Object-Oriented Software. 1. Addison-Wesley, ISBN

9 Kurze Erklärungen zu den beteiligten Klassen (1 bis 2 Absätze) Aufzählung der verwandten oder beteiligten weiteren Patterns Aufzuführende Patterns 1. Abstract Factory 2. Adapter 3. Bridge 4. Builder 5. Chain of Responsibility 6. Command 7. Composite 8. Decorator 9. Facade 10. Factory Method 11. Flyweight 12. Interpreter 13. Iterator 14. Mediator 15. Memento 16. Observer 17. Prototype 18. Proxy 19. Singleton 20. State 21. Strategy 22. TemplateMethod 23. Visitor 9

10 2.6 Anhang Glossar Das Buch muss ein Glossar führen. Das Glossar listet die im Buch verwendeten Fachbegriffe mit deren Definition auf. 2.7 Anhang Literaturverzeichnis Jeder Hinweis auf ein literarisches Werk referenziert mit einem Kürzel auf das Literaturverzeichnis. Das Literaturverzeichnis umfasst pro Eintrag folgende Angaben: 1. Name und Vorname des Autors oder der Autoren 2. Titel 3. Nummer der Auflage, sofern bekannt 4. Verlag 5. Erscheinungsjahr 6. ISBN Nummer 2.8 Anhang Abbildungsverzeichnis Jede Abbildung trägt gleich darunter eine eindeutige Bezeichnung. Das lückenlose Abbildungsverzeichnis im Anhang führt die Nummern der betreffenden Seiten auf. 2.9 Index Das Buch muss einen vollwertigen Index haben. Die Einträge müssen nach Alphabet geordnet sein, aus Hauptstichwort und wenn anwendbar Unterstichworten bestehen. Das Hauptstichwort ist dabei massgebend für die Ordnung. Bei jedem Eintrag sind alle relevanten Seitennummern aufzuführen. 10

11 2.10 UML Diagramme Im Buch sind im Bereich der Java Swing Lösungen und der Design Patterns UML - Diagramme einzufügen, sofern diese für das Verständnis förderlich sind. Als Kriterium gilt: Sobald mehrere Klassen erwähnt sind und diese in irgendeinem Zusammenhang zueinander stehen, soll dies in UML - Diagrammen dargestellt werden. Die UML - Diagramme sind gemäss Standard UML 2.1 zu zeichnen Buchentwurf Ein weiteres Ziel dieser Master Thesis ist die Erstellung eines Buches. Da der Zeitrahmen dafür zu klein ist, muss erstmal ein Entwurf zu einem Buch entstehen. Gliederung, Satz und Darstellung müssen entsprechend gewählt werden. Als Hilfsmittel für die Gestaltung und Erstellung des Manuskripts ist Latex einzusetzen Abbildungen Mit Ausnahme von Screenshots müssen alle Abbildungen als Vector - Grafiken eingefügt werden, damit eine hohe Ausgabequalität erzielt wird Deliverables Buch Als einzelnes PDF File zu liefern Source Code der Beispiele Als einzelnes ZIP File zu liefern. 11

12 3 Planung 12