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