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