מדריך סגנון לממשק המשתמש של תוספים ל-Google Workspace

התוספים ל-Google Workspace צריכים להיות עקביים עם הסגנון והפריסה של אפליקציית המארח שהם מרחיבים. הם צריכים להרחיב את ממשק המשתמש באופן טבעי באמצעות אמצעי בקרה והתנהגויות מוכרים. ההנחיות שמוצגות כאן מתארות דרכים לטפל בטקסט, בתמונות, באמצעי בקרה ובמיתוג כדי לקדם חוויית משתמש באיכות גבוהה.

אם התוסף פותח דפי אינטרנט נפרדים שמהווים חלק בלתי נפרד מהפעולה של התוסף (למשל דף הגדרות של התוסף), צריך לוודא שגם דפי האינטרנט האלה עומדים בהנחיות הסגנון האלה.

טקסט ותמונות

בקטע הזה מוסבר איך להשתמש בטקסט ובתמונות בתוסף בצורה נכונה.

שם התוסף

צריך להגדיר את שם התוסף במניפסט של הפרויקט שלו וגם כשמגדירים את התוסף לפרסום. השם מופיע במקומות רבים, כמו בדף האפליקציה ב-Google Workspace Marketplace ובתפריטים. כשבוחרים שם:

  • חשוב להשתמש באותיות רישיות בתחילת כל מילה.
  • אל תשתמשו בסימני פיסוק, במיוחד בסוגריים, אלא אם הם חלק מהמותג.
  • מומלץ להשתמש בשם קצר – עד 15 תווים. יכול להיות ששמות ארוכים ייחתכו אוטומטית בדף של האפליקציה ב-Google Workspace Marketplace ובמקומות אחרים.
  • לא כדאי לכלול בשם התוסף את המילים Google,‏ Gmail או שמות אחרים של מוצרי Google.
  • אל תכללו את המילה 'חבילת ערוצים' בשם חבילת הערוצים.
  • לא לכלול פרטי גרסה.

סגנון כתיבה

לא צריך לכתוב הרבה. רוב הפעולות צריכות להיות ברורות באמצעות סמלים, פריסה ותוויות קצרות. אם יש חלק בתוסף שצריך הסבר מפורט יותר ממה שאפשר לספק באמצעות תוויות קצרות, מומלץ ליצור דף אינטרנט נפרד עם תיאור של התוסף ולקשר אליו.

כשכותבים טקסט לממשק משתמש:

  • משתמשים באותיות רישיות רק בתחילת משפט (במיוחד ללחצנים, לתוויות ולפעולות בכרטיסים).
  • מומלץ להשתמש בטקסט קצר ופשוט ללא מונחים מקצועיים או ראשי תיבות.

פעולות אוניברסליות ופעולות בכרטיס

אם משתמשים בפעולות אוניברסליות או בפעולות בכרטיסים בתוסף, הן מופיעות כפריטים בתפריט הכרטיסים שאתם מגדירים. אתם יכולים לבחור את הטקסט שיופיע בתפריטים האלה עבור הפעולות האלה. כשבוחרים את הטקסט לשימוש:

  • מומלץ להימנע מטקסט בתפריט שפשוט חוזר על השם של התוסף.
  • מתחילים כל פריט בתפריט במילה שמציינת פעולה, כמו "הפעלה", "הגדרה" או "יצירה".
  • צריך לתאר את המשימה, לא את רכיב ממשק המשתמש שבו מוצגת הפעולה.
  • אם הפעולה מתחילה תהליך עבודה ואין פועל יחיד שמתאר את מה שהיא עושה, קוראים לה Start.
  • כדאי להקפיד על מספר קטן של פריטים בתפריט כדי שהמשתמש לא ייאלץ לגלול ברשימה ארוכה. אם יש לכם עוד פעולות להטמעה, כדאי להשתמש בכמה כרטיסים עם פעולות שונות בכל אחד מהם.

הודעות שגיאה

כשמשהו משתבש, חשוב להשתמש בשפה פשוטה. תסביר את הבעיה מנקודת המבט של המשתמש ותציע דרכים לפתור אותה.

  • לא לאפשר למשתמש לראות חריגים שהקוד יוצר. במקום זאת, משתמשים בהצהרות try...catch כדי ליירט חריגים, ואז מציגים הודעת שגיאה ידידותית למשתמש.
  • לפני שמפרסמים את התוסף, חשוב לוודא שהוא לא מציג מידע על ניפוי באגים בממשק המשתמש.

תוכן עזרה

מומלץ לעצב כרטיסים שבהם מוצג מידע עזרה או הסבר על אופן הפעולה של התוסף למשתמש. אם אתם יוצרים תוכן עזרה לתוסף, חשוב לזכור:

  • אם אפשר, כדאי להציג את ההוראות ברשימה עם תבליטים או ברשימה ממוספרת. להסביר למשתמשים את התהליך עד לתוצאה הסופית, עם הפניות ברורות לרכיבי ממשק משתמש עם שמות.
  • חשוב לוודא שההוראות מסבירות בבירור את כל הדרישות, כמו הגדרת גיליון אלקטרוני בצורה מסוימת.
  • אתם יכולים לקשר לתוכן עזרה חיצוני, כמו דפי אינטרנט תומכים.

תמונות

התמונות שבהן משתמשים בתוסף הן או אחת מסוגי הסמלים המובנים או תמונה שמתארחת באופן ציבורי ומוגדרת באמצעות כתובת URL. כשמשתמשים בתמונות שמתארחות בשרת, חשוב לוודא שהן נגישות לכל מי שעשוי להשתמש בתוסף.

פקדים

בקטע הזה מפורטות הנחיות בנושא חוויית משתמש עבור ווידג'טים אינטראקטיביים.

כפתורים

מומלץ להשתמש בלחצנים כדי לשלוט בפעולות העיקריות בממשק המשתמש, ולא בווידג'טים אחרים.

  • רוב תוויות הלחצנים של הטקסט צריכות להתחיל בפועל.
  • ברוב המקרים, כדאי להגביל את מספר הכפתורים בשורות הכפתורים לשלושה או פחות.

DecoratedText

ווידג'טים של DecoratedText מאפשרים להציג תוכן טקסט עם סמלים, לחצנים או מתגים.

  • חשוב להשתמש באות גדולה בתחילת המשפט בתוכן הטקסט.
  • הטקסט בווידג'ט DecoratedText נחתך אם הוא לא נכנס לשטח הזמין. לכן, כדאי תמיד לנסות לשמור על תוכן הטקסט קצר ככל האפשר.

בחירת קלט

אתם יכולים להשתמש במגוון של ווידג'טים של מקורות קלט לבחירה בתוסף: תיבות בחירה נפתחות, תיבות סימון ולחצני בחירה.

  • משתמשים בתיבות סימון כשאנשים יכולים לבחור כמה אפשרויות או לא לבחור אף אפשרות. משתמשים בלחצני בחירה (או בתפריט בחירה) כשצריך לבחור בדיוק אפשרות אחת. כדאי להשתמש בתפריטים נפתחים כשרוצים לספק רשימה קצרה של חלופות ולחסוך מקום בממשק המשתמש.
  • חשוב להשתמש באות גדולה בתחילת המשפט (באנגלית) לטקסט שמוקצה לכל אפשרות.
  • מומלץ להימנע משימוש בשינויים בבחירה כדי להפעיל פעולות משמעותיות שקשה לבטל, כי אנשים טועים לעיתים קרובות כשהם בוחרים. במקום זאת, אפשר להוסיף לחצן שקורא את ערכי הבחירה הנוכחיים ואז מפעיל את הפעולה.
  • בתפריטים הנפתחים, כדאי למיין את האפשרויות לפי סדר אלפביתי או לפי סדר הגיוני שכל המשתמשים יכולים להבין (למשל, הצגת הימים בשבוע לפי הסדר, החל מיום ראשון או מיום שני).
  • הגבלת מספר האפשרויות בווידג'ט של קלט בחירה למספר סביר. אם יש יותר מדי אפשרויות, יכול להיות שהמשתמשים יתקשו להשתמש בווידג'ט. במקרים כאלה, כדאי לחלק את האפשרות לקטגוריות שונות ולכמה ווידג'טים.

קלט טקסט

שדות להזנת טקסט מספקים למשתמשים מקום להזנת נתונים מסוג מחרוזת.

  • אל תשתמשו בשדה להזנת טקסט כדי שהמשתמש יקליד אחת ממערכת ספציפית של ערכים אפשריים. במקום זאת, אפשר להשתמש בתפריט נפתח.
  • השתמשו ברמזים ובהצעות כדי לעזור למשתמש להזין טקסט בפורמט ובתוכן הנכונים.
  • אם הטקסט שרוצים להזין כולל יותר מכמה מילים, צריך להשתמש בקלט טקסט רב-שורה.

מיתוג

בקטע הזה מפורטות הנחיות לגבי חוויית המשתמש בהוספת רכיבי מיתוג לממשק של התוסף.

בתוסף

אם רוצים לכלול מיתוג בממשק המשתמש של התוסף, צריך להקפיד על מיתוג קצר ופשוט. כך אנשים יכולים להתמקד בפונקציונליות של התוסף.

  • כל ההיבטים של התוסף צריכים לעמוד בדרישות של הנחיות המיתוג.
  • לא כוללים את המילה Google,‏ Gmail או שמות של מוצרים אחרים של Google.
  • אסור לכלול סמלים של מוצרי Google, גם אם הם שונו.
  • אל תכללו את המילה 'תוסף' בטקסט המיתוג.
  • טקסט המיתוג צריך לכלול כמה מילים בלבד.

ב-Google Workspace Marketplace

כשמגדירים את התוסף לפרסום, צריך לספק כמה נכסי טקסט וגרפיקה כדי ליצור את הדף של התוסף ב-Google Workspace Marketplace.

כל ההיבטים של דף האפליקציה בחנות והנכסים האלה צריכים לעמוד בדרישות ההנחיות למיתוג.