בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- קסם
- כותבים טכניים:
- Favour Kelvin
- שם הפרויקט:
- Knowledgebase
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
מופשט
מאגר ידע הוא מאגר מרכזי שבו המידע מאוחסן, מאורגן ולאחר מכן משותף. כשמשתמשים בבסיס הידע באופן חיצוני, הוא משמש את המשתמשים כמקום שבו הם יכולים למצוא את כל המידע שהם צריכים על המוצרים או השירותים של החברה, על הארגון ועל התחום שבו החברה פועלת. לעומת זאת, מאגר ידע פנימי משמש בדרך כלל כדרך לאפשר לקהילה או למשתמשים לשתף פעולה ולהפיץ את כל הידע והמידע של החברה באופן פנימי. התוכן של מאגרי ידע ספציפיים משתנה בהתאם לגורמים רבים, אבל ברוב המקרים הם כוללים מידע שיעזור לכם להתחיל להשתמש במוצרים ספציפיים, ללמוד איך להשתמש בתכונות המתקדמות ולהתגבר על בעיות או בעיות נפוצות. היתרון העיקרי של יצירת מאגר ידע והצגתו לקהל הוא שהוא מאפשר לכם לספק מידע מעמיק, מיידי ומותאם אישית, ותשובות לחברי הקהל/למשתמשים/לקהילה שלכם, בלי שתצטרכו לעשות זאת בנפרד.
מאגר הידע של Mautic הוא מאגר מרכזי של מדריכים, מדריכי הוראות ושיטות מומלצות בנושאים שקשורים ל-Mautic – בין שבאופן ישיר (למשל, איך מבצעים פעולות ב-Mautic) ובין שבאופן עקיף (למשל, אסטרטגיות שיווק כלליות יותר).
נכון למועד כתיבת המאמר הזה, מאגר הידע של Mautic הוא חדש יחסית ולא שלם. קהילת Mautic רוצה להשתמש בפרויקט הזה כדי לשפר את האופן שבו היא מספקת מידע מעמיק על פי דרישה במסמכי התיעוד למשתמש, כדי לאפשר למשתמשי הקצה ליהנות מחוויית שימוש חלקה ב-Mautic. קריאת מאגר הידע של Mautic הייתה מועילה מאוד, אבל היו חסרים מדריכים מעודכנים והדרכות לשימוש, וגם יצירת מדריכים חדשים שתואמים לגרסה 3x של Mautic.
ההתרשמוות הראשונות שלי אחרי שעיינתי במסמכים הקיימים כרגע, מאגר הידע של Mautic זמין בכתובת https://kb.mautic.org/. חלק מהמדריכים, מדריכי ה-How-To ונושאי השיטות המומלצות במסמכי העזרה לא מעודכנים, חלקם דלים או חלקיים, וחלקם לא כוללים מידע על הגרסה הנוכחית של Mautic.
למה השיפור שהצעת עדיף על השיפור הנוכחי/אילו תחומים אשמח לתרום להם? השיפור המוצע נועד לשפר ולהבטיח יעילות, עקביות ושקט נפשי לכל משתמשי הקצה. הוא יכיל מדריכים בכתב ומדריכים למתחילים, שיטות מומלצות ותמונות שמשויכות אליהן. הוא יכלול הוראות והסברים על השימוש בכל אחת מהתכונות של Mautic, והוא יהיה עדכני, קל לניווט וברור.
ניתוח
מאגר הידע של Mautic נכתב במערכת ניהול התוכן של Grav עם קובץ שטוח ועיצוב KLB4. בדקתי הרבה דרכים לשפר את המסמכים במאגר הידע
יעדי הפרויקט
- לסקור את מאגר הידע.
- מעדכנים את המדריכים וההדרכות כך שיתאימו לגרסה 3x של Mautic.
- יצירת משאבים למאגר הידע החדש של קהילת Mautic
- כותבים סדרה של מדריכים והדרכות שיעזרו למשתמשי Mautic להגדיר את האפליקציה, להגדיר אותה ולהשתמש בה בצורה יעילה יותר.
- צריך לעדכן את סרטון ההדרכה כך שיתאים לגרסה של Mautic 3x.
- מסירים תמונות ומידע מיושנים.
- לשכתב את מאגר הידע כדי שיהיה קל יותר להבין אותו.
- לוודא שההטמעה של מדריך הסגנון או התבנית של התיעוד של מרכז העזרה מתבצעת בצורה נכונה
ציר הזמן
לפני 1 באוגוסט
- אפשר להמשיך לתרום לארגון.
- כדאי להכיר את מסמכי התיעוד במאגר הידע ואת הגרסה הנוכחית של Mautic.
- תלמדו טכניקות חדשות וכישורי כתיבה טכנית שיעזרו לכם להטמיע את הפרויקט.
יצירת קשרים בקהילה (1 באוגוסט עד 1 בספטמבר)
- הגדרת ערוץ תקשורת ושעה (בגלל הפרש השעות)
- לשפר את היעדים ולהגדיר ציפיות משני הצדדים
- מידע נוסף על הקהילה ועל המוצר
- דיון על מבנה המסמכים המוצע עם המנטורים ועם חברים אחרים בארגון.
- להשלים את התכונות המוצעות ושינויים אחרים שצריך לבצע במסמך הקיים.
תקופת התיעוד
- שבוע 1 (2 בספטמבר עד 22 בנובמבר)
- במהלך התקופות האלה אעבוד ישירות עם המנטורים שלי כדי :
- לסקור את מאגר הידע.
- מעדכנים את המדריכים וההדרכות כך שיתאימו לגרסה 3x של Mautic.
- יצירת משאבים למאגר הידע החדש של קהילת Mautic
- כותבים סדרה של מדריכים והדרכות שיעזרו למשתמשי Mautic להגדיר את האפליקציה, להגדיר אותה ולהשתמש בה בצורה יעילה יותר.
- צריך לעדכן את סרטון ההדרכה כך שיתאים לגרסה של Mautic 3x.
- מסירים תמונות ומידע מיושנים.
- כתבו מחדש את מאגר הידע כדי שיהיה קל יותר להבין אותו.
- לוודא שהטמעת הפורמט או הסגנון של התיעוד במאגר הידע בוצעה בצורה נכונה.
- בהתאם לקצב הפרסום, כי צוות הפיתוח יהיה עסוק בהשקות של תכונות קטנות
הערכת פרויקט (25 בנובמבר עד 29 בנובמבר 2019)
- שליחת דוח פרויקט והערכה על ידי המנטורים שלי
- לכתוב ולשלוח דוח על החוויה שלי כמשתתף בעונה של Docs.