מדריך הסגנון הזה נועד לעזור לכם להחליט איך להכין תבניות לגלריית התבניות של הקהילה. מדריך הסגנון הזה מבוסס על עקרונות הכתיבה של Google Material Design. במילים פשוטות, אלה:
- השם צריך להיות תמציתי
- כותבים בצורה פשוטה ופשוטה
- פנייה למשתמשים בצורה ברורה
- העברת פרטים חיוניים
- כתיבה לכל רמות הקריאה
- כותבים בצורה אנושית: כותבים לאנשים, לא לרובוטים
מומלץ לפעול לפי ההנחיות הבאות כדי לוודא שלכל התבניות יש מראה ותחושה עקביים, וכדי לעזור למשתמשים להבין איך להשתמש בתבנית.
מידע
ההנחיות האלה חלות על פריטים שמופיעים בכרטיסייה מידע של עורך התבניות.
שם
שם התבנית מוצג למשתמשים ב-Tag Manager בממשק המשתמש של Tag Manager ובגלריית התבניות לקהילות. הוא מופיע בחלק העליון של דף הפרטים של התבנית, וגם כשמוצגות רשימות של תבניות.
- כותבים את שם החברה או הארגון ואת השם הפונקציונלי של התבנית: שם הארגון שם התבנית.
- שימוש באותיות רישיות בתחילת כל מילה.
- השתמשו במונחים שמתארים את הפונקציונליות.
- מומלץ להימנע משימוש במונח 'רשמי' בשמות של תבניות, אלא אם קיבלתם הרשאה לעשות זאת מהארגון הרלוונטי.
דוגמאות: MyCompany Conversion Measurement Tag, MyCompany Campaign ID Variable
תיאור
תיאור התבנית הוא תיאור של התבנית שמופיע בדפי פרטים כסיכום קצר של הפונקציונליות של התבנית.
- כדאי להשתמש במשפטים ברורים ותמציתיים כדי לתאר את הפעולות שהתבנית מבצעת.
- צריך לציין בבירור איך התבנית תורמת למשתמש. לדוגמה: "התבנית של הכלי ליצירת קהלים ב-Example.com יכולה לעזור לכם ליצור רשימות קהלים חדשות ממבקרים באתר".
- הימנעו משימוש בשפה מקצועית.
- מומלץ לכלול קישורים למידע נוסף, למסמכי תיעוד ולתמיכה.
סמל
סמל התבנית מיוצג כתמונה ממוזערת כשהיא מופיעה ב-Tag Manager ובגלריית התבניות של הקהילה.
- הפורמט של התמונה צריך להיות PNG, JPEG או GIF.
- התמונה צריכה להיות ריבועית, בגודל של 48 על 48 פיקסלים לפחות, ולא יותר מ-96 על 96 פיקסלים.
- גודל הקובץ צריך להיות קטן מ-50KB.
- הימנעו משימוש בסמלי לוגו רשמיים של חברות, אלא אם קיבלתם הרשאה לעשות זאת מהארגון הרלוונטי.
- שדות
- בכרטיסייה 'שדות' של עורך התבניות, אפשר להוסיף רכיבי טופס כמו קלט טקסט, תיבות סימון וכו'.
שדות
הנחיות הסגנון האלה חלות על הכרטיסייה שדות בעורך התבניות.
שם הפרמטר
זהו השם של השדה כפי שהוא מופיע בעורך התבניות, אבל לא כפי שהוא מופיע למשתמש. השמות צריכים לתאר את סוג הנתונים שבהם נעשה שימוש. הפורמט של שמות הפרמטרים הוא lowerCamelCase. דוגמאות: userName, customerID, shoppingCartValue.
תוויות שדות
תוויות השדות כוללות שדות של שמות מוצגים, טקסט של תיבות סימון ופריטים קשורים.
- מכילה אות גדולה בתחילת המשפט (באנגלית).
- קצר יותר הוא טוב יותר.
- השתמשו בתיאורים בחוכמה.
- להשתמש במילים נפוצות.
טקסט עזרה
טקסט עזרה הוא תוכן מידע שמוצג ככלי עזר, כדי לעזור למשתמש להזין ערך תקף בשדה התבנית. אם אפשר, כדאי לספק דוגמה לקלט ולתאר את אופן השימוש בשדה התבנית או את ההשפעה של מתן ערכים מסוימים.
- מכילה אות גדולה בתחילת המשפט (באנגלית).
- השם צריך להיות תמציתי, אבל גם אנושי. מותר להשתמש בקיצור מילים ולכתוב בלשון פנייה שנייה (את/ה).
- סוגי השדות הנתמכים
- מותר להשתמש בפורמט HTML בסיסי. דוגמאות:
<strong>, <em>.
סוגי השדות הנתמכים
סוג |
תיאור |
|---|---|
| קלט טקסט | קלט טקסט. הערך של פרמטר תבנית מהסוג הזה יהיה מחרוזת שעשויה להפנות למשתנים. הווידג'ט להזנת טקסט שמוצג בממשק המשתמש של Tag Manager יכול להיות שדה טקסט של שורה אחת או שדה טקסט של כמה שורות. |
| תפריט נפתח | תפריט נפתח שבו אפשר לבחור רק פריט אחד בתור הערך של פרמטר התבנית. כדאי לרשום את הפריטים בסדר אלפביתי, אלא אם יש סיבה טובה לעשות אחרת. |
| תיבת סימון | קלט של תיבת סימון. הערך של פרמטר תבנית מהסוג הזה יהיה בוליאני: true אם התיבה מסומנת, ו-false אם היא לא מסומנת. |
| לחצן בחירה | קלט רדיו. פרמטר תבנית מהסוג הזה מציג רשימה של אפשרויות בממשק המשתמש של Tag Manager, והמשתמש רשאי לבחור רק אחת מהאפשרויות כערך של פרמטר התבנית. |
| טבלה פשוטה | קלט פשוט של טבלה. אפשר לערוך כל תא בטבלה במקום, וכל תא יכול להיות רק משני סוגים: קלט טקסט או תפריט נפתח. הערך של פרמטר תבנית מהסוג הזה הוא מערך של אובייקטים: כל אובייקט מקודד שורה, כל מפתח באובייקט חייב להיות אחד משמות העמודות וכל ערך באובייקט הוא הערך של התא התואם. |