Przewodnik po stylu interfejsu dodatków do Google Workspace

Dodatki do Google Workspace powinny być zgodne z stylu i układu aplikacja hostująca które się poszerzają. Powinny rozszerzyć interfejs. dzięki dobrze znanym elementom sterującym i działaniom. Przedstawione wytyczne w tym sposoby radzenia sobie z tekstem, obrazami, elementami sterującymi i elementami marki, dbają o wygodę użytkowników.

Jeśli dodatek otwiera oddzielne strony internetowe, które są integralną częścią (np. stronę ustawień dodatku), upewnij się, że te strony przestrzegaj tych wskazówek.

Tekst i obrazy

Ta sekcja zawiera informacje o tym, jak prawidłowo używać tekstu i obrazów w dodatku.

Nazwa dodatku

Musisz ustawić nazwę dodatku w jego projekcie manifest, a kiedy skonfigurować dodatek na potrzeby publikacji. Nazwa jest widoczna w wielu miejscach, takich jak Google Workspace Marketplace i w menu. Podczas wybierania nazwy:

  • Jak nazwy własne.
  • Unikaj znaków interpunkcyjnych, zwłaszcza nawiasów, jeśli nie są one częścią Twojej marki.
  • Zadbaj o to, aby tekst był krótki – najlepiej będzie, gdy otrzymasz nie więcej niż 15 znaków. Długie nazwy mogą być są automatycznie obcięte na stronie aplikacji w Google Workspace Marketplace i w innych miejscach.
  • Nie używaj słów „Google”, „Gmail” ani nazw innych usług Google. w nazwie dodatku.
  • Nie wpisuj słowa „dodatek” w nazwie dodatku.
  • Nie podawaj informacji o wersji.

Styl pisania

Nie musisz pisać zbyt wiele. Większość działań powinna być jasno przedstawiona przez ikony, układ i krótkie etykiety. Jeśli zauważysz, że część dodatku wymaga bardziej obszernego wyjaśnienia niż krótkie etykiety, dlatego najlepiej możesz utworzyć osobną stronę internetową z opisem swojego dodatku i umieścić na niej link.

Podczas wpisywania tekstu interfejsu:

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

Działania uniwersalne i karty

Jeśli używasz działań uniwersalnych lub działania karty na pojawiają się jako pozycje menu na kartach zdefiniowanych przez reklamodawcę. Możesz wybrać tekst, który będzie używany w tych menu w tych menu . Podczas wybierania tekstu, którego chcesz użyć:

  • Unikaj tekstu menu, który stanowi tylko nazwę dodatku.
  • Każdy element menu powinien rozpocząć się od słowa działania, np. „Uruchom”, „Skonfiguruj” lub „Utwórz”.
  • Opisz zadanie, a nie komponent interfejsu wyświetlany w ramach działania.
  • Twoje działanie rozpoczyna się od przepływu pracy i nie ma jednego czasownika, który je znał nazywa się „Start”.
  • Nie powinno się ograniczać do liczby elementów menu, żeby użytkownik nie musiał przewijać strony obszerną listę. Jeśli chcesz wprowadzić więcej działań, skorzystaj z po kilka kart z różnymi działaniami.

Komunikaty o błędach

Gdy coś pójdzie nie tak, należy pisać prostym językiem. Wyjaśnij: z perspektywy użytkownika i podpowiedz, jak go rozwiązać.

  • Nie zezwalaj użytkownikowi na wyświetlanie żadnych wyjątków zgłoszonych przez Twój kod. Zamiast tego: użyj instrukcji try...catch do przechwycenia wyjątków, a następnie wyświetl czytelny komunikat o błędzie.
  • Przed opublikowaniem sprawdź, czy dodatek nie wyświetla informacji debugowania w interfejsie.

Materiały edukacyjne

Możesz zaprojektować karty z informacjami o pomocy lub objaśnieniami na temat jego działania na koncie użytkownika. Jeśli utworzysz materiały pomocy dla o dodatku:

  • Jeśli to możliwe, pokazuj instrukcje w formie listy punktowanej lub numerowanej. Użytkownicy pieszo z wyraźnymi odwołaniami do nazwanych elementów interfejsu.
  • Dopilnuj, aby instrukcje zawierały jasne informacje o wymaganiach, takich jak konfiguracja arkusza kalkulacyjnego w określony sposób.
  • Możesz podać linki do zewnętrznych materiałów pomocy, na przykład stron internetowych pomocniczych.

Obrazy

Obrazy użyte w dodatku to jeden z wbudowane typy ikon lub publicznie hostowany obraz określony przez adres URL. Jeśli używasz obrazów hostowanych, upewnij się, że są one dostępne dla wszystkich osób, które mogą korzystać z Twojego dodatku.

Elementy sterujące

Ta sekcja zawiera wytyczne dotyczące wygody użytkowników interaktywne widżety.

Przyciski

Zamiast używać przycisków do sterowania głównymi działaniami interfejsu z innymi widżetami.

  • Większość etykiet przycisków tekstowych powinna zaczynać się od czasownika.
  • W większości przypadków wiersze przycisków powinny być ograniczone do trzech lub mniej przycisków.

DecoratedText

Widżety dekoracji tekstu umożliwiają prezentowanie treści tekstowych za pomocą ikon, przycisków lub przełączników.

  • W tekście stosuj wielkość liter jak w zdaniu.
  • Tekst widżetu decorationedText jest obcinany, jeśli nie mieści się w dostępnego miejsca. Z tego powodu staraj się zawsze zachować jak najkrótszą.

Wybrane dane wejściowe

Możesz wykorzystać różne widżety do wprowadzania danych w swoim dodatku: menu wyboru, pola wyboru i przyciski.

  • Użyj pól wyboru, gdy użytkownicy mogą wybrać wiele opcji lub nie mogą wybrać żadnej opcji. Użyj przycisków (lub menu wyboru), gdy musisz zaznaczyć dokładnie jedną opcję. Korzystając z menu, podaj krótką listę alternatywnych rozwiązań i oszczędzać miejsce w interfejsie.
  • W tekście przypisanym do każdej opcji używaj wielkości liter jak w zdaniu.
  • Unikaj stosowania zmian w zaznaczonych elementach, które wywołują duże, trudne do odwrócenia działania. bo klienci często popełniają błędy przy dokonywaniu wyborów. Zamiast tego rozważ dodanie przycisku, który odczytuje bieżące wartości wyboru, a następnie uruchamia działanie; działanie.
  • W przypadku menu posortuj opcje alfabetycznie lub według schematu logicznego zrozumiałe dla wszystkich użytkowników (np. podając dni tygodnia, w kolejności, od niedzieli lub poniedziałku).
  • Ogranicz liczbę opcji w danym polu wejściowym do rozsądnej liczby kliknięć. Jeśli jest zbyt wiele opcji, użytkownicy mogą znaleźć trudno jest korzystać z widżetu. W takich przypadkach zastanów się nad usunięciem opcji w różnych kategoriach i wielu widżetach.

Pole tekstowe

W polu tekstowym użytkownicy mogą wpisywać dane w postaci ciągu znaków.

  • Nie używaj danych wejściowych, aby użytkownik wpisał tekst do określonego zbioru możliwe wpisy. Zamiast tego użyj opcji z menu.
  • Skorzystaj ze wskazówek i sugestii, aby pomóc użytkownikowi wprowadzić prawidłowy tekst format i zawartość.
  • Jeśli wpisany tekst składa się z kilku wierszy, użyj funkcji wprowadzania tekstu wielowierszowego słowa kluczowe.

Promowanie marki

Ta sekcja zawiera wskazówki dotyczące dodawania elementów marki w celu zapewnienia wygody użytkownikom w interfejsie dodatku.

W dodatku

Jeśli chcesz dodać elementy marki do interfejsu dodatku, powinien on być zwięzły i zwięzły. Pomoże to innym skupić się na funkcjach Twojego dodatku.

  • Wszystkie aspekty dodatku muszą być zgodne z wskazówkami dotyczącymi promowania marki.
  • Nie używaj słów „Google”, „Gmail” ani nazw innych usług Google.
  • Nie umieszczaj ikon usług Google, nawet jeśli zostały one zmienione.
  • Nie wpisuj słowa „dodatek” w tekście marki.
  • Tekst dotyczący marki nie powinien zawierać więcej niż kilku słów.

W Google Workspace Marketplace

Gdy skonfigurujesz dodatek na potrzeby publikacji, otrzymasz wiele zasobów graficznych i tekstowych, by utworzyć Informacje o aplikacji w Google Workspace Marketplace.

Wszystkie aspekty strony aplikacji i zasoby muszą być zgodne z wskazówkami dotyczącymi promowania marki.