Google Workspace-Add-ons sollten dem Stil und Layout der Hostanwendung entsprechen, die sie erweitern. Die Benutzeroberfläche sollte auf natürliche Weise erweitert werden, indem vertraute Steuerelemente und Verhaltensweisen verwendet werden. Die hier vorgestellten Richtlinien beschreiben, wie Sie Text, Bilder, Steuerelemente und Branding so gestalten, dass eine hohe Nutzerfreundlichkeit gewährleistet wird.
Wenn Ihr Add‑on separate Webseiten öffnet, die ein integraler Bestandteil der Funktionsweise des Add‑ons sind (z. B. eine Einstellungsseite für das Add‑on), müssen diese Webseiten ebenfalls diesen Stilrichtlinien entsprechen.
Text und Bilder
In diesem Abschnitt erfahren Sie, wie Sie Text und Bilder in Ihrem Add-on richtig verwenden.
Add‑on-Name
Sie müssen den Namen des Add-ons im Manifest des Projekts und bei der Konfiguration des Add-ons für die Veröffentlichung festlegen. Der Name wird an vielen Stellen angezeigt, z. B. im Google Workspace Marketplace-Eintrag und in Menüs. Bei der Namenswahl gilt Folgendes:
- Verwenden Sie die korrekte Groß- und Kleinschreibung.
- Vermeiden Sie Satzzeichen, insbesondere Klammern, es sei denn, sie sind Teil Ihrer Marke.
- Halten Sie die Eingabe kurz – am besten nicht länger als 15 Zeichen. Lange Namen werden im Google Workspace Marketplace-Eintrag und an anderen Stellen möglicherweise automatisch gekürzt.
- Verwenden Sie in Ihrem Add-on-Namen nicht die Wörter „Google“, „Gmail“ oder andere Google-Produktnamen.
- Verwenden Sie das Wort „Add‑on“ nicht im Namen Ihres Add‑ons.
- Versionsinformationen weglassen
Schreibstil
Sie müssen nicht viel schreiben. Die meisten Aktionen sollten durch Symbole, Layout und kurze Labels deutlich gemacht werden. Wenn Sie feststellen, dass ein Teil Ihres Add-ons eine ausführlichere Erklärung erfordert, als kurze Labels bieten können, ist es ratsam, eine separate Webseite zu erstellen, auf der Ihr Add-on beschrieben wird, und darauf zu verlinken.
Beim Schreiben von UI-Text:
- Verwenden Sie die normale Groß- und Kleinschreibung (insbesondere für Schaltflächen, Labels und Kartenaktionen).
- Verwenden Sie kurze, einfache Texte ohne Fachbegriffe oder Akronyme.
Universal- und Kartenaktionen
Wenn Sie universelle Aktionen oder Kartenaktionen in Ihrem Add-on verwenden, werden sie als Menüelemente in den von Ihnen definierten Karten angezeigt. Sie können den Text auswählen, der in diesen Menüs für diese Aktionen verwendet wird. Bei der Auswahl des zu verwendenden Texts gilt Folgendes:
- Vermeiden Sie Menütext, der einfach den Namen des Add-ons wiederholt.
- Beginnen Sie jeden Menüpunkt mit einem Tätigkeitswort wie „Ausführen“, „Konfigurieren“ oder „Erstellen“.
- Beschreiben Sie die Aufgabe und nicht die UI-Komponente, in der die Aktion angezeigt wird.
- Wenn mit Ihrer Aktion ein Workflow gestartet wird und es kein einzelnes Verb gibt, das beschreibt, was sie tut, nennen Sie sie „Start“.
- Halten Sie die Anzahl der Menüpunkte gering, damit der Nutzer nicht durch eine lange Liste scrollen muss. Wenn Sie mehrere Aktionen implementieren müssen, sollten Sie mehrere Karten mit jeweils unterschiedlichen Aktionen verwenden.
Fehlermeldungen
Wenn etwas schiefgeht, ist es wichtig, eine einfache Sprache zu verwenden. Erkläre das Problem aus der Sicht des Nutzers und schlage vor, wie es behoben werden kann.
- Lassen Sie den Nutzer keine Ausnahmen sehen, die von Ihrem Code ausgelöst werden. Verwenden Sie stattdessen
try...catch-Anweisungen, um Ausnahmen abzufangen und dann eine nutzerfreundliche Fehlermeldung anzuzeigen. - Prüfen Sie vor der Veröffentlichung, ob in der Benutzeroberfläche Ihres Add-ons Debugging-Informationen angezeigt werden.
Hilfeinhalte
Sie können Karten entwerfen, auf denen Hilfeinformationen angezeigt oder die Funktionsweise des Add-ons für den Nutzer erklärt wird. Wenn Sie Hilfeinhalte für Ihr Add-on erstellen, denken Sie daran:
- Wenn möglich, sollten Sie Anleitungen in einer Aufzählungs- oder nummerierten Liste darstellen. Führen Sie Nutzer zum Endergebnis und verweisen Sie dabei deutlich auf benannte UI-Elemente.
- Achten Sie darauf, dass in Ihren Anweisungen alle Anforderungen klar erläutert werden, z. B. wie eine Tabelle eingerichtet werden muss.
- Sie können gerne auf externe Hilfeinhalte wie Supportwebseiten verweisen.
Bilder
Bilder, die in Ihrem Add-on verwendet werden, sind entweder einer der integrierten Symbole oder ein öffentlich gehostetes Bild, das über eine URL angegeben wird. Wenn Sie gehostete Bilder verwenden, müssen Sie darauf achten, dass sie für alle Nutzer Ihres Add-ons zugänglich sind.
Steuerelemente
Dieser Abschnitt enthält Richtlinien zur Nutzerfreundlichkeit für interaktive Widgets.
Schaltflächen
Verwenden Sie Schaltflächen, um die wichtigsten Aktionen der Benutzeroberfläche zu steuern, anstatt andere Widgets.
- Die meisten Textschaltflächen-Labels sollten mit einem Verb beginnen.
- Schaltflächenzeilen sollten in den meisten Fällen auf maximal drei Schaltflächen beschränkt sein.
DecoratedText
Mit DecoratedText-Widgets können Sie Textinhalte mit Symbolen, Schaltflächen oder Schaltern präsentieren.
- Achten Sie auf korrekte Groß- und Kleinschreibung.
- Der Text eines DecoratedText-Widgets wird abgeschnitten, wenn er nicht in den verfügbaren Platz passt. Versuchen Sie daher immer, den Textinhalt so kurz wie möglich zu halten.
Auswahleingaben
Sie können in Ihrem Add-on verschiedene Auswahl-Widgets verwenden: Drop-down-Auswahlfelder, Kästchen und Optionsfelder.
- Verwenden Sie Kästchen, wenn Nutzer mehrere oder keine Option auswählen können. Verwenden Sie Optionsfelder (oder ein Auswahlmenü), wenn genau eine Option ausgewählt werden muss. Verwenden Sie Drop-downs, wenn Sie eine kurze Liste mit Alternativen bereitstellen und gleichzeitig Platz in der Benutzeroberfläche sparen möchten.
- Verwenden Sie für den Text, der jeder Option zugewiesen ist, die korrekte Groß- und Kleinschreibung.
- Vermeiden Sie es, mit Auswahländerungen wichtige, schwer rückgängig zu machende Aktionen auszulösen, da Nutzer bei der Auswahl häufig Fehler machen. Fügen Sie stattdessen eine Schaltfläche hinzu, mit der die aktuellen Auswahlwerte gelesen und die Aktion ausgelöst wird.
- Sortieren Sie die Optionen in Drop-down-Menüs alphabetisch oder nach einem logischen Schema, das alle Nutzer verstehen können (z. B. die Wochentage in der richtigen Reihenfolge, beginnend mit Sonntag oder Montag).
- Beschränken Sie die Anzahl der Optionen in einem bestimmten Auswahl-Widget auf eine angemessene Anzahl. Wenn es zu viele Optionen gibt, kann es für Nutzer schwierig sein, das Widget zu verwenden. In solchen Fällen sollten Sie die Option in verschiedene Kategorien und mehrere Widgets aufteilen.
Texteingaben
Über Texteingaben können Nutzer String-Daten eingeben.
- Verwenden Sie keine Texteingabe, damit der Nutzer einen der möglichen Einträge eingibt. Verwenden Sie stattdessen eine Drop-down-Auswahl.
- Verwenden Sie Hinweise und Vorschläge, um dem Nutzer zu helfen, Text mit dem richtigen Format und Inhalt einzugeben.
- Verwenden Sie mehrzeilige Texteingaben, wenn der einzugebende Text mehr als ein paar Wörter umfasst.
Branding
In diesem Abschnitt finden Sie Richtlinien zur Nutzerfreundlichkeit beim Hinzufügen von Branding-Elementen zur Add-on-Oberfläche.
In Ihrem Add‑on
Wenn Sie Branding in die Benutzeroberfläche Ihres Add-ons einfügen möchten, halten Sie es kurz und dezent. So können sich Nutzer auf die Funktionen Ihres Add-ons konzentrieren.
- Alle Aspekte Ihres Add-ons müssen den Markenrichtlinien entsprechen.
- Verwenden Sie nicht die Wörter „Google“, „Gmail“ oder andere Google-Produktnamen.
- Verwenden Sie keine Google-Produktsymbole, auch wenn sie verändert wurden.
- Das Wort „Add-on“ darf nicht im Branding-Text enthalten sein.
- Der Branding-Text sollte nicht mehr als ein paar Wörter umfassen.
Im Google Workspace Marketplace
Wenn Sie Ihr Add-on für die Veröffentlichung konfigurieren, stellen Sie eine Reihe von grafischen und Text-Assets zur Verfügung, um den Eintrag im Google Workspace Marketplace zu erstellen.
Alle Aspekte Ihres Store-Eintrags und dieser Assets müssen den Branding-Richtlinien entsprechen.