בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Mautic
- כותבים טכניים:
- סווטי טאקר
- שם הפרויקט:
- בדיקת מסמכי התיעוד של משתמשי הקצה ב-Mautic ועדכון שלהם
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
ההתרשמות הראשונה שלי מעיון במסמכים הקיימים:
נכון לעכשיו, המסמכים ארוכים, רבים מהם יתירים, חלקם לא מלאים וחלקם לא מסודרים, ולכן יכול להיות שיהיה קשה למשתמשים למצוא את המידע שהם מחפשים.
כמשתמש חדש, לא הצלחתי להבין איך אלמנטים שונים ב-Mautic, כמו קמפיינים, נכסים, מסרים, קטגוריות וכו', משתלבים יחד כדי לתת מענה לצרכים עסקיים. ההצעה שלי היא ליצור נושא רעיוני ברמה גבוהה שמתאר כל רכיב מאוטי ב-2-3 שורות. הנושא הזה יכול לקשר לנושאים המפורטים השונים של המשימות לגבי כל אחד מהרכיבים האלה.
ניתן להרחיב את המדריך לתורמים כך שיכלול מידע נוסף, כמו למשל, איך לפתוח בעיה, להציע תוכן או רעיונות חדשים, לדווח על באגים, בעיות או פרצות אבטחה וכו', על ידי הוספת קישורים לפורומים, לערוצי Slack ולמאגרי Git. בנוסף, צריך להרחיב את מדריך הסגנון כך שיכלול מוסכמות טיפוגרפיות רגילות, הנחיות לתמונות, טבלאות וכו'.
בנוסף, יש לא מעט מידע לגבי 'אימיילים', 'קמפיינים' ומידע ישן/לא מיושן שצריך לעדכן.
התחום שבו אני רוצה לתרום:
במהלך הדיונים על הערוצים של Slack, שבהם משתמשים מקיימים אינטראקציה ישירה עם הקהילה המאוטית, הבנתי שקמפיינים ואימיילים הם אלמנטים חיוניים ב-Mautic. בדקתי את התיעוד בנושא קמפיינים באמצעות Mautibox בגרסה 3, וגיליתי שהוא זקוק לשיפוץ יסודי. ריכזתי כאן כמה בעיות שמצאתי והצעות שלי לכל אחת מהן:
- המשתמש ב-Mautic יכול לבחור מבין מגוון פעולות, החלטות ותנאים בזמן בניית קמפיין. חסרים מסמכים לגבי פעולות והחלטות רבות, ואין כמעט מסמכים לגבי תנאי הקמפיינים. אנחנו צריכים לזהות את המידע החסר ולהוסיף אותו למסמך של משתמש הקצה.
- הקמפיינים יכולים להיות פשוטים או מורכבים מאוד. המסמכים הקיימים לא מספקים ערך רב למשתמשים שיוצרים קמפיינים בפעם הראשונה. ההצעה שלי היא לציין תרחישים לדוגמה (פשוטים ומורכבים) וליצור תהליכי עבודה לדוגמה (באמצעות מדריכים מפורטים או נושאים במדריך למשתמש הקצה או בסרטוני הדרכה) שמשתמשים חדשים יכולים לעיין בהם לפני שהם מתחילים ליצור קמפיינים משלהם.
- צריך להציג את המידע באופן מסודר וארגוני יותר בקטע הזה. כדי לשפר את נוחות השימוש, צריך לפעול לפי גישה שמבוססת על משימות ועל קונספטים. הנושאים יכולים להשתמש בטבלאות כדי להציג מידע על פעולות, החלטות ותנאים. הנושא 'שימוש בטריגרים לפי תאריך' נראה לא במקום. אפשר להוסיף אותו לקטגוריה 'תנאים'.
בנוסף לקמפיינים, בדקתי גם את המסמכים של הודעות האימייל מול ממשק המשתמש. זה מה שאני מציע שנעבוד עליו:
- תוכן דינמי באימיילים זמין לתבניות אימייל עם קוד מותאם אישית (גם לאימיילים מתוך תבניות וגם לאימיילים מתוך פלחים), אבל אין כרגע מסמכי עזרה בנושא. מוסיפים פרטים על התפקיד של תוכן דינמי ועל אופן ההגדרה שלו, יחד עם כמה דוגמאות.
- מוסיפים נושא נפרד למעקב אחר אימיילים. המידע יכול לכלול מידע על השימוש בווידג'טים של אימייל שזמינים בלוח הבקרה, ואיך אפשר להשתמש בהם כדי לעקוב אחרי מדדים ופעילויות שקשורות לאימייל. בנוסף, כדאי להעביר לכאן מידע על אימיילים למעקב.
- במסמכי העזרה לא צוין בבירור שהאפשרויות 'תשובות של איש קשר', 'ניהול החזרות (bounces)' ו'הבעלים של השירות לשליחת אימיילים' הן הגדרות גלובליות שאפשר להגדיר בקטע 'הגדרות אימייל'. כל הגדרות האימייל צריכות להיות חלק מנושא גג. בנוסף, הרבה הגדרות אימייל אחרות, כמו כללי תדירות ברירת מחדל, הגדרות לביטול הרשמה לא מתועדות בכלל. ציינו אילו הגדרות הן חובה ואילו אופציונליות.
- בדף הניהול של העזיבה מהדף הראשון, מסירים את כל המידע על ה-webhooks ומציבים אותו בנושא נפרד בשביל ה-webhooks. לאחר מכן נוכל לספק קישור לנושא הזה מכאן.
בנוסף: - בנושא 'מרכז הבקרה' יש מידע חלקי על הווידג'טים הזמינים. המידע הזה חשוב וצריך להוסיף אותו כי הוא עוזר למשתמשים לנתח את המשאבים שלהם ב-Mautic ולעקוב אחריהם.
צריך לבדוק את כל המסמכים כדי לזהות פערים. אנחנו צריכים לשפר את המסמך כדי שיהיה קל יותר למשתמשים שלנו להבין אותו.
איך אפשר לצפות שהידע/הניסיון שלי יועילו לפרויקט הזה?
במהלך החודש האחרון, טיפלתי בבעיות שונות במסמכי העזרה של Mautic, כולל הוספת תמיכה לגרסה האחרונה של Mautic 3.0. כך הצלחתי להכיר את המבנה של מסמכי העזרה למשתמשים, וגם לזהות את הפערים במסמכים. הקדשתי זמן למחקר של מסמכי העזרה של כלים אחרים לאוטומציה שיווקית והשוואה שלהם למסמכי העזרה של Mautic למשתמשי קצה, כדי להבין איך נוכל למלא את הפערים האלה במסמכי העזרה שלנו. היכרותי עם שפת ה-HTML, הכלים והתהליכים של קוד פתוח היא יתרון נוסף. התחלתי ללמוד כרגע קורס במחקר בנושא חוויית משתמש ואני יכול ליישם את העקרונות האלה כדי ליצור תיעוד שמכוון יותר למשתמשים. בנוסף, הניסיון שלי בארכיטקטורת מידע יאפשר לי לארגן את התוכן ולהציע רעיונות להתאמת המסמכים שלנו ליעדים של המשתמשים. נוסף על כך, יש לי כישרון להרחיב את הידע שלי בתחומים טכניים חדשים. יש לי 10 שנות ניסיון בכתיבה טכנית, וניסיון קודם ב-GSOD, שבו השלמתי בהצלחה פרויקט עבור ארגון בתחום טכני שהיה חדש לי לגמרי. אני בטוח שאוכל לתרום את חלקי למסמכי העזרה של Mautic.