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

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

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

טקסט ותמונות

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

שם התוסף

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

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

סגנון כתיבה

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

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

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

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

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

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

הודעות שגיאה

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

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

תוכן עזרה

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

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

תמונות

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

אמצעי בקרה

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

לחצנים

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

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

טקסט מעוצב

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

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

אפשרויות קלט נבחרות

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

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

קלט הטקסט

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

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

פרטי החברה

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

בתוסף שלך

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

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

ב-Google Workspace Marketplace

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

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