תבנית סגנון של מדריך

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

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

ההנחיות הבאות יעזרו לכם להבטיח שלכל התבניות יש מראה ותחושה עקביים וכדי לעזור למשתמשים להבין איך להשתמש בתבנית.

מידע

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

שם

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

  • משתמשים בשם החברה/ארגון ובשם הפונקציונלי של התבנית: שם הארגון שם התבנית.
  • אות ראשונה רישית בכל המילים.
  • יש להשתמש במונחים שמתארים את הפונקציונליות.
  • יש להימנע משימוש במונח "רשמי" בשמות של תבניות, אלא אם הארגון נתן לכם הרשאה לעשות זאת.

דוגמאות: תג מעקב המרות של MyCompany, משתנה של מזהה קמפיין ב-MyCompany

תיאור

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

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

סמל

סמל התבנית מיוצג כתמונה ממוזערת כשהוא רשום ב-Tag Manager ובגלריית התבניות של הקהילה.

  • פורמט התמונה צריך להיות PNG , JPEG או GIF.
  • התמונה צריכה להיות ריבוע, לפחות 48 פיקסלים על 48 פיקסלים, ולא יותר מ-96 פיקסלים על 96 פיקסלים.
  • גודל הקובץ צריך להיות פחות מ-50 קילובייט.
  • יש להימנע משימוש בסמלי לוגו רשמיים של החברה, אלא אם יש לכם הרשאה לעשות זאת על ידי הארגון הרלוונטי.
  • שדות
  • אפשר להשתמש בכרטיסייה 'שדות' של עורך התבניות כדי להוסיף רכיבי טופס כמו קלט טקסט, תיבות סימון וכו'.

שדות

הנחיות סגנון אלה חלות על הכרטיסייה שדות של עורך התבניות.

שם הפרמטר

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

תוויות השדות

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

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

טקסט עזרה

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

  • חשוב להשתמש באות גדולה בתחילת משפט (באנגלית).
  • השם צריך להיות תמציתי, אבל צריך להיות אנושי. אין בעיה להשתמש בחוזים ולכתוב באדם השני (את/ה).
  • סוגי שדות נתמכים
  • מותר להשתמש בפורמט HTML בסיסי. דוגמאות: <strong>, <em>.

סוגי שדות נתמכים

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