Przewodnik po stylu interfejsu dodatków do Google Workspace

Dodatki do Google Workspace powinny być zgodne ze stylem i układem aplikacji hostującej, które rozszerzają. Powinni w naturalny sposób rozszerzyć interfejs, stosując znane elementy sterujące i zachowania. Przedstawione tu wytyczne opisują sposoby postępowania z tekstem, obrazami, elementami sterującymi i elementami budowania marki, które służą zwiększaniu wygody użytkowników.

Jeśli dodatek otwiera osobne strony internetowe, które stanowią integralną część jego działania (na przykład stronę ustawień dodatku), upewnij się, że strony te są zgodne z tymi wskazówkami dotyczącymi stylu.

Tekst i obrazy

Ta sekcja wyjaśnia, jak poprawnie korzystać z tekstu i obrazów w dodatku.

Nazwa dodatku

Nazwę dodatku musisz podać w pliku manifestu jego projektu oraz podczas konfigurowania dodatku do publikacji. Nazwa ta wyświetla się w wielu miejscach, takich jak Google Workspace Marketplace i w menu. Podczas wybierania nazwy:

  • Stosuj wielkość liter jak w nazwach własnych.
  • Unikaj znaków interpunkcyjnych, zwłaszcza nawiasów, chyba że stanowią część Twojej marki.
  • Niech będzie krótki – najlepiej nie więcej niż 15 znaków. Długie nazwy mogą być automatycznie obcinane na stronie Google Workspace Marketplace i w innych miejscach.
  • W nazwie dodatku nie używaj słów „Google”, „Gmail” ani innych usług Google.
  • Nie używaj słowa „dodatek” w nazwie dodatku.
  • Pomiń informacje o wersji.

Styl pisania

Nie musisz dużo pisać. Większość działań powinna być wyraźnie widoczna za pomocą ikon, układu i krótkich etykiet. Jeśli uważasz, że część dodatku wymaga bardziej szczegółowego wyjaśnienia niż krótkie etykiety, najlepiej utworzyć osobną stronę internetową z opisem dodatku i umieścić do niego link.

Podczas pisania tekstu interfejsu:

  • Stosuj wielkość liter jak w zdaniu (zwłaszcza w przypadku przycisków, etykiet i działań na kartach).
  • Wybieraj krótki, prosty tekst bez żargonu i akronimów.

Działania uniwersalne i działania karty

Jeśli w dodatku używasz działań uniwersalnych lub działań związanych z kartą, pojawiają się one jako pozycje menu na zdefiniowanych przez Ciebie kartach. Możesz wybrać tekst, który będzie używany w tych menu do wykonywania tych czynności. Podczas wybierania tekstu do użycia:

  • Unikaj tekstu menu, który zawiera tylko powtórzoną nazwę dodatku.
  • Każdą pozycję menu zacznij od słowa działania, np. „Uruchom”, „Skonfiguruj” lub „Utwórz”.
  • Opisz zadanie, a nie element interfejsu, który wyświetla się po kliknięciu reklamy.
  • Jeśli działanie inicjuje przepływ pracy i nie ma jednego czasownika, który go opisuje, nazwij je „Rozpocznij”.
  • Liczba pozycji menu powinna być mała, aby uniknąć zmuszenia użytkownika do przewijania obszernej listy. Jeśli chcesz wdrożyć więcej działań, rozważ użycie wielu kart z różnymi działaniami na każdej z nich.

Komunikaty o błędach

Gdy coś pójdzie nie tak, używaj prostego języka. Przedstaw problem z punktu widzenia użytkownika i podpowiedz, jak go rozwiązać.

  • Nie zezwalaj użytkownikowi na wyświetlanie wyjątków zgłaszanych przez Twój kod. Zamiast tego użyj instrukcji try...catch do przechwytywania wyjątków, a następnie wyświetlaj przyjazny dla użytkownika komunikat o błędzie.
  • Przed opublikowaniem upewnij się, że dodatek nie wyświetla w interfejsie użytkownika danych debugowania.

Materiały edukacyjne

Warto zaprojektować karty z informacjami o pomocy lub wyjaśnieniem działania dodatku użytkownikowi. Jeśli tworzysz materiały pomocy związane z dodatkiem, pamiętaj o tych kwestiach:

  • Jeśli to możliwe, wyświetlaj instrukcje w formie listy punktowanej lub numerowanej. Pokaż użytkownikom efekt końcowy, używając wyraźnych odwołań do nazwanych elementów interfejsu.
  • Upewnij się, że instrukcje jasno wyjaśniają wszelkie wymagania, takie jak konfiguracja arkusza kalkulacyjnego w określony sposób.
  • Możesz podać linki do zewnętrznych materiałów pomocy, np. stron internetowych.

zdjęcia;

Obrazy używane w dodatku to jeden z typów wbudowanych ikon lub obrazy przechowywane publicznie na serwerze określonym przez adres URL. Jeśli używasz hostowanych obrazów, upewnij się, że są one dostępne dla wszystkich użytkowników, którzy mogą korzystać z dodatku.

Opcje

W tej sekcji znajdziesz wskazówki dotyczące wygody użytkowników związane z widżetami interaktywnymi.

Przyciski

Do sterowania głównymi działaniami w interfejsie użytkownika zamiast innych widżetów używaj przycisków.

  • Większość etykiet przycisków tekstowych powinna zaczynać się od czasownika.
  • W większości przypadków liczba przycisków nie powinna przekraczać 3 pozycji.

Tekst Dekorowany

Widżety decorationedText umożliwiają wyświetlanie treści tekstowej za pomocą ikon, przycisków lub przełączników.

  • Wielkość liter powinna być jak w zdaniu.
  • Tekst widżetu decorationedText jest obcinany, jeśli nie mieści się w dostępnym miejscu. Dlatego staraj się, by tekst był jak najkrótszy.

Dane wejściowe wyboru

W dodatku możesz korzystać z rozmaitych widżet do wprowadzania danych: z menu, pól wyboru i przycisków opcji.

  • Używaj pól wyboru, jeśli użytkownicy mogą zaznaczyć kilka opcji lub nie mogą ich wybrać wcale. Jeśli trzeba wybrać tylko jedną opcję, użyj przycisków (lub menu wyboru). Za pomocą menu możesz podać krótką listę alternatywnych rozwiązań, aby zaoszczędzić miejsce w interfejsie.
  • W tekście przypisanym do każdej opcji używaj wielkości liter jak w zdaniu.
  • Unikaj wprowadzania zmian w swoich ustawieniach w taki sposób, aby wywoływać poważne, trudne do odwrócenia działania, ponieważ użytkownicy często popełniają błędy podczas dokonywania wyborów. Zamiast tego możesz dodać przycisk, który odczytuje bieżące wartości wybranych opcji, a potem wywołuje działanie.
  • W przypadku menu uporządkuj opcje alfabetycznie lub logicznie w sposób zrozumiały dla wszystkich użytkowników (np. uporządkuj dni tygodnia w kolejności od niedzieli lub poniedziałku).
  • Ogranicz liczbę opcji w danym widżecie wyboru do rozsądnej liczby. Zbyt wiele opcji może utrudnić korzystanie z widżetu. W takich przypadkach warto podzielić tę opcję na kilka kategorii i widżetów.

Pole tekstowe

Umożliwiają one użytkownikom wpisywanie danych w polu tekstowym.

  • Nie stosuj wprowadzania danych tekstowych, by wprowadzać użytkowników w błąd. Zamiast tego użyj opcji wyboru z menu.
  • Korzystaj ze wskazówek i sugestii, by ułatwić użytkownikom wpisywanie tekstu w odpowiednim formacie i treści.
  • Jeśli chcesz wpisać więcej słów, użyj wielowierszowego wprowadzania tekstu.

Marka

W tej sekcji znajdziesz wskazówki dotyczące wygody użytkowników związane z dodawaniem elementów marki do interfejsu dodatku.

W Twoim dodatku

Jeśli chcesz zawrzeć markę w interfejsie dodatku, powinien on być zwięzły i zwięzły. Dzięki temu użytkownicy mogą skupić się na funkcjach dodatku.

  • Wszystkie aspekty dodatku muszą być zgodne ze wskazówkami dotyczącymi marki.
  • Nie używaj słów „Google”, „Gmail” ani innych nazw usług Google.
  • Nie przesyłaj ikon usług Google, nawet jeśli zostały zmienione.
  • W tekście związanym z marką nie używaj słowa „dodatek”.
  • Tekst dotyczący marki powinien składać się z maksymalnie kilku słów.

W Google Workspace Marketplace

Podczas konfigurowania dodatku do publikacji udostępniasz wiele zasobów graficznych i tekstowych, dzięki którym utworzysz stronę w Google Workspace Marketplace.

Wszystkie aspekty informacji o aplikacji i te zasoby muszą być zgodne ze wskazówkami dotyczącymi promowania marki.