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

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

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

טקסט ותמונות

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

שם התוסף

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

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

סגנון כתיבה

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

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

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

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

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

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

הודעות שגיאה

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

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

תוכן עזרה

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

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

תמונות

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

פקדים

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

כפתורים

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

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

DecoratedText

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

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

קלט של בחירה

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

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

קלט טקסט

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

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

מיתוג

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

בתוסף

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

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

ב-Google Workspace Marketplace

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

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