Eclipse User Interface Guidelines

Transkript

1 SS 2009 Softwarequalität C. M. Bopda, S. Vaupel

2 Motivation (Problem) Motivation (Problem) Eclipse is a universal tool platform - an open, extensible IDE for anything, but nothing in particular. Durch beliebige Erweiterungen (Plugins) kann ein gewisser Wildwuchs der Benutzeroberfläche von Eclipse entstehen.

3 Motivation (Lösung) Motivation (Lösung) These guidelines are intended for use by designers and implementors of an Eclipse user interface extension. Durch Richtlinien (Guidelines) kann das einheitliche Erscheinungsbild von Eclipse gewährleistet werden. Dies vereinfacht das Arbeiten für den Entwickler mit verschiedenen Plugins.

4 Motivation (Problem) Die Richtlinien unterstützen die Prinzipien des guten GUI Designs Benutzerführung Direkte Interaktion Sicherstellung der Konsistenz (Menüstruktur o. ä.) Fehlertoleranz und Rückmeldungen Ansprechendes Design Einfachheit

5 Quelle N. Edgar, K. Haaland, J. Li und K. Peter entwickelten allgemeine Richtlinien zum Design von Eclipse Erweiterungen. Die Version 2.1 (Stand November 2007) ist unter in englischer Sprache erhältlich.

6 Terminologie

7 Dokument Aufbau der Richtlinien 16 Kapitel: Allgemeine Informationen zum Aufbau von Eclipse (Kapitel 3, Introduction) Style-Icons und Wizard Graphics (Kapitel 6, UI Graphics) Komponentendesign (Kapitel 7, Component Development) + Commands + Dialogs + Wizards + Editors + Views + Perspectives + Windows + Properties + Widgets Standard Komponenten (Kapitel 8, Standard Components) + Navigation View + Task View + Selection Dialogs + Preference Dialog Checkliste für Plugin-Entwickler (Kapitel 13, Checklist For Developers)

8 Guidelinebeispiele Graphics Guideline 2.9 Follow the specific size specifications for each type of graphic.

9 Guidelinebeispiele Views & Editors Guideline 7.5 A view can be opened from the Window > Show View menu.

10 Guidelinebeispiele Views & Editors Guideline 7.2 Put only the most commonly used commands on the view toolbar. Any command on a toolbar must also appear in a menu, either the window menu, context menu or the view menu.

11 Guidelinebeispiele Views & Editors Guideline 7.13 Fill the context menu with selection oriented actions.

12 Fallbeispiel

13 Fallbeispiel Was stimmt hier nicht?

14 Fallbeispiel Was stimmt hier nicht? Guideline 3.1 The label and Tool tip must use Headline style capitalization.

15 Fallbeispiel Was stimmt hier nicht? Guideline 6.12 Use the Standard format for editor context menus.

16 Fallbeispiel Was stimmt hier nicht? Guideline 3.1 Each command must have a label, tool tip, and full color image.

17 Fallbeispiel Was stimmt hier nicht? Guideline 6.22 An error or warning image should be added to items with the error or warning respectively.

18 Fallbeispiel Was stimmt hier nicht? Guideline 6.5 The editor should be labeled with the name of the file, document, or input being edited.

19 Fallbeispiel Was stimmt hier nicht? Guideline 6.5 The editor should be labeled with the name of the file, document, or input being edited.

20 Fallbeispiel Alle User Interface Guidelines erfüllt.

21 Top Ten Eclipse UI Verstöße Top Ten Eclipse UI Verstöße Schlechte Grafiken oder Nichtkonsistenz gegenüber Eclipse Grafiken Schlecht dargestellte Dialoge oder Assistenten Sinnlose Dialoge Unverständliche Fehlermeldungen Nachrichten mit verketteten Strings

22 Top Ten Eclipse UI Regeln Top Ten Eclipse UI Regeln Verwende das Eclipse Look and Feel für Erweiterungen. Verwende allgemeine SWT Komponenten. Sei mit den APIs (application programming interface) der UI (User Interface) vertraut. Gestalte Benutzer Icons und Grafiken konsistent zu dem Eclipse Erscheinungsbild. Kenne die Konventionen, die das Betriebssystem vorschreibt. Erstelle verständliche Fehlermeldungen um Benutzer das Beheben des Problems zu erleichtern. Erzeuge keine Dialoge oder Assistenten in einem Fehlerfall. Stelle quick fix und quick assist Mechanismen bereit. Plane Zeit für das Überarbeiten der Erweiterung ein.

23 Zusammenfassung Zusammenfassung Die Eclipse User Interface Guidelines garantieren im Allgemeinen ein einheitliches, benutzerfreundliches, konsistentes und gut benutzbares Erscheinungsbild der Eclipse Erweiterungen. Vorgänge sind aufgrund der Ähnlichkeiten zwischen den einzelnen Erweiterungen schnell erlernbar und erhöhen so die Softwarequalität.