Dodatki do Google Workspace powinny być zgodne ze stylem i układem aplikacji hosta, którą rozszerzają. Powinien rozszerzyć interfejs użytkownika w naturalny sposób, używając znanych elementów sterujących i zachowań. Przedstawione tu wytyczne opisują sposoby postępowania z tekstem, obrazami, elementami sterującymi i marką, które zapewniają wysoką jakość obsługi przez użytkowników.
Jeśli dodatek otwiera osobne strony internetowe, które są integralną częścią jego działania (np. strona ustawień dodatku), upewnij się, że te strony internetowe również są zgodne z tymi wytycznymi dotyczącymi stylu.
Tekst i obrazy
Z tej sekcji dowiesz się, jak prawidłowo używać tekstu i obrazów w dodatku.
Nazwa dodatku
Musisz ustawić nazwę dodatku w jego pliku manifestu projektu i podczas konfigurowania dodatku do publikacji. Nazwa pojawia się w wielu miejscach, np. w Google Workspace Marketplace i w menu. Podczas wybierania nazwy:
- Używaj wielkości liter jak w nazwach własnych.
- Unikaj znaków interpunkcyjnych, zwłaszcza nawiasów, chyba że są częścią marki.
- Powinien być krótki – najlepiej, jeśli nie przekracza 15 znaków. Długie nazwy mogą być automatycznie skracane w informacjach o aplikacji w Google Workspace Marketplace i w innych miejscach.
- Nie umieszczaj w nazwie dodatku wyrazów „Google”, „Gmail” ani innych nazw usług Google.
- Nie umieszczaj słowa „dodatek” w nazwie dodatku.
- Pomiń informacje o wersji.
Styl pisania
Nie musisz dużo pisać. Większość działań powinna być jasna dzięki ikonografii, układowi i krótkim etykietom. Jeśli część dodatku wymaga bardziej szczegółowego wyjaśnienia niż krótkie etykiety, warto utworzyć osobną stronę internetową z opisem dodatku i umieścić na niej link do niego.
Podczas pisania tekstu interfejsu:
- Używaj wielkich liter tylko na początku zdania (zwłaszcza w przypadku przycisków, etykiet i działań na kartach).
- Używaj krótkiego, prostego tekstu bez żargonu i akronimów.
Działania uniwersalne i działania na karcie
Jeśli w dodatku używasz działań uniwersalnych lub działań na kartach, pojawiają się one jako elementy menu na zdefiniowanych przez Ciebie kartach. Możesz wybrać tekst, który będzie używany w tych menu w przypadku tych działań. Wybierając tekst do użycia:
- Unikaj tekstu menu, który po prostu powtarza nazwę dodatku.
- Każdy element menu zaczynaj od słowa oznaczającego działanie, np. „Uruchom”, „Skonfiguruj” lub „Utwórz”.
- Opisz zadanie, a nie komponent interfejsu, który wyświetla działanie.
- Jeśli działanie rozpoczyna proces i nie ma jednego czasownika, który opisuje, co robi, nazwij je „Rozpocznij”.
- Ogranicz liczbę pozycji menu, aby użytkownik nie musiał przewijać długiej listy. Jeśli masz więcej działań do wdrożenia, rozważ użycie kilku kart z różnymi działaniami na każdej z nich.
Komunikaty o błędach
Gdy coś pójdzie nie tak, ważne jest, aby używać prostego języka. Wyjaśnij problem z perspektywy użytkownika i zaproponuj sposób jego rozwiązania.
- Nie zezwalaj użytkownikowi na wyświetlanie żadnych wyjątków zgłaszanych przez Twój kod. Zamiast tego używaj instrukcji
try...catchdo przechwytywania wyjątków, a następnie wyświetlaj przyjazny dla użytkownika komunikat o błędzie. - Przed opublikowaniem dodatku sprawdź, czy w interfejsie nie są wyświetlane informacje debugowania.
Materiały edukacyjne
Możesz zaprojektować karty, które wyświetlają informacje pomocy lub wyjaśniają użytkownikowi działanie dodatku. Jeśli tworzysz treści pomocy dotyczące dodatku, pamiętaj, aby:
- W miarę możliwości wyświetlaj instrukcje w postaci listy punktowanej lub numerowanej. Prowadź użytkowników do ostatecznego wyniku, wyraźnie odwołując się do nazwanych elementów interfejsu.
- Upewnij się, że instrukcje jasno wyjaśniają wszelkie wymagania, np. dotyczące określonego sposobu konfiguracji arkusza kalkulacyjnego.
- Możesz umieszczać linki do zewnętrznych materiałów pomocy, np. do stron internetowych.
Obrazy
Obrazy używane w dodatku to wbudowane typy ikon lub publicznie hostowane obrazy określone 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 dodatku.
Opcje
W tej sekcji znajdziesz wytyczne dotyczące wrażeń użytkownika w przypadku interaktywnych widżetów.
Przyciski
Do sterowania głównymi działaniami interfejsu użytkownika używaj przycisków, a nie innych widżetów.
- Większość etykiet przycisków tekstowych powinna zaczynać się od czasownika.
- W większości przypadków wiersze przycisków powinny zawierać maksymalnie 3 przyciski.
DecoratedText
Widżety DecoratedText umożliwiają wyświetlanie treści tekstowych z ikonami, przyciskami lub przełącznikami.
- W przypadku treści tekstowych używaj wielkości liter jak w zdaniu.
- Tekst widżetu DecoratedText jest obcinany, jeśli nie mieści się w dostępnym miejscu. Dlatego zawsze staraj się, aby tekst był jak najkrótszy.
Dane wejściowe wyboru
W dodatku możesz używać różnych widżetów do wprowadzania wyboru: pól wyboru, pól wyboru i przycisków opcji.
- Używaj pól wyboru, gdy użytkownicy mogą wybrać kilka opcji lub żadną z nich. Używaj przycisków opcji (lub menu wyboru), gdy użytkownik musi wybrać dokładnie jedną opcję. Używaj menu, gdy podajesz krótką listę alternatyw, a jednocześnie chcesz zaoszczędzić miejsce w interfejsie.
- W przypadku tekstu przypisanego do każdej opcji używaj wielkości liter jak w zdaniu.
- Unikaj używania zmian wyboru do wywoływania ważnych, trudnych do cofnięcia działań, ponieważ użytkownicy często popełniają błędy podczas dokonywania wyboru. Zamiast tego możesz dodać przycisk, który odczytuje bieżące wartości wyboru, a następnie wywołuje działanie.
- W przypadku menu rozwijanych opcje powinny być posortowane alfabetycznie lub według logicznego schematu zrozumiałego dla wszystkich użytkowników (np. dni tygodnia w kolejności, zaczynając od niedzieli lub poniedziałku).
- Ogranicz liczbę opcji w widżecie wejściowym wyboru do rozsądnej liczby. Jeśli opcji jest zbyt wiele, użytkownicy mogą mieć trudności z korzystaniem z widżetu. W takich przypadkach rozważ podzielenie opcji na różne kategorie i wiele widżetów.
Pola tekstowe
Pola tekstowe umożliwiają użytkownikom wpisywanie danych w postaci ciągów znaków.
- Nie używaj pola tekstowego, aby użytkownik wpisywał jedną z określonych wartości. Zamiast tego użyj menu wyboru.
- Używaj wskazówek i sugestii, aby ułatwić użytkownikowi wpisywanie tekstu w odpowiednim formacie i z odpowiednią treścią.
- Jeśli wpisywany tekst ma więcej niż kilka słów, używaj pól tekstowych wielowierszowych.
Promowanie marki
W tej sekcji znajdziesz wytyczne dotyczące dodawania elementów marki do interfejsu dodatku.
W dodatku
Jeśli chcesz umieścić elementy marki w interfejsie dodatku, zadbaj o to, aby były krótkie i nie przytłaczały użytkownika. Dzięki temu użytkownicy mogą skupić się na funkcjach dodatku.
- Wszystkie aspekty dodatku muszą być zgodne z wytycznymi dotyczącymi marki.
- Nie używaj słów „Google”, „Gmail” ani innych nazw usług Google.
- Nie używaj ikon produktów Google, nawet jeśli są zmodyfikowane.
- Nie używaj słowa „dodatek” w tekście dotyczącym marki.
- Tekst marki powinien składać się z kilku słów.
W Google Workspace Marketplace
Podczas konfigurowania dodatku do publikacji podajesz szereg zasobów graficznych i tekstowych, aby utworzyć wpis w Google Workspace Marketplace.
Wszystkie aspekty informacji o aplikacji i tych komponentów muszą być zgodne z wytycznymi dotyczącymi marki.