פרויקט מאוטי

דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.

סיכום הפרויקט

ארגון הקוד הפתוח:
מאוטי
כתב טכני:
העדפה לקלווין
שם הפרויקט:
מאגר ידע
אורך הפרויקט:
אורך רגיל (3 חודשים)

תיאור הפרויקט

מופשט

מאגר ידע הוא מאגר מרכזי שבו מאוחסן, מאורגן ולאחר מכן משותף מידע. כשמשתמשים בו באופן חיצוני, בסיס הידע הוא המקום שאליו המשתמשים יכולים ללמוד כל מה שהם צריכים לדעת על המוצרים או השירותים של החברה, על הארגון ועל התעשייה שלה. מצד שני, בדרך כלל משתמשים בבסיס ידע פנימי כדי לאפשר לקהילה או למשתמשים לשתף פעולה ולהפיץ את כל הידע והמידע של החברה באופן פנימי. התוכן של מאגרי ידע ספציפיים משתנה בהתאם לכמה גורמים, אבל בדרך כלל רובם כוללים מידע שיעזור לכם להתחיל להשתמש במוצרים ספציפיים, להשתמש יותר בתכונות המתקדמות ולהתגבר על בעיות או בעיות נפוצות. היתרון העיקרי של יצירה והצגה של מאגר ידע לקהל שלכם הוא היכולת לספק מידע מעמיק, מיידי ועל פי דרישה, ולענות לחברי הקהל/למשתמשים/לקהילה שלכם, ללא צורך לעשות זאת בנפרד.

Mautic Knowledgebase הוא מאגר מרכזי למדריכים, למדריכים ולשיטות מומלצות בנושאים שקשורים ל-Mautic - באופן ישיר (למשל, איך לעשות דברים ב-Mautic) או באופן עקיף (למשל, אסטרטגיות שיווק כלליות יותר).

נכון למועד כתיבת הנתונים האלה, מאגר הידע של Mautic הוא חדש ולא שלם. קהילת Mautic רוצה להשתמש בפרויקט הזה כדי לספק לתיעוד המשתמש מידע מפורט ולפי דרישה, כדי לאפשר למשתמשי הקצה ליהנות מחוויה חלקה בזמן השימוש ב-Mautic. המעבר על מאגר הידע של Mautic היה די אינפורמטיבי, אבל היה צורך במדריכים מעודכנים ובמדריכים גם ליצירה של מדריכים חדשים ולהתאמה לגרסת Mautic 3x.

הרושם הראשוני שלי הוא במהלך עיון במסמכי התיעוד הקיימים נכון לעכשיו, מאגר הידע של Mautic זמין בכתובת https://kb.mautic.org/. חלק מהמדריכים, המדריכים והנושאים של שיטות העבודה המומלצות במסמכי התיעוד אינם עדכניים, חלקיים או חלקיים, וגם לא כוללים מידע על הגרסה הנוכחית של ה-mautic.

מדוע הצעת השיפור שלך בתחום הנוכחי/בתחומים שאשמח לתרום להם? השיפור המוצע יהיה לשפר ולהבטיח יעילות, עקביות ושקט נפשי לכל משתמשי הקצה. האתר יכיל מדריכים כתובים, מדריכי הפעלה ושיטות מומלצות ואת התמונות המשויכות אליו, וכן הוראות והסבר לגבי השימוש בכל אחת מהתכונות של ה-mautic, העדכניות, הקלות לניווט וההבנה.

ניתוח

מאגר הידע של Mautic נכתב במערכת ניהול התוכן עם קבצים שטוחים ב-Grav ובעיצוב KLB4. חקרתי הרבה על דרכים לשיפור התיעוד של מאגר הידע

יעדי הפרויקט

  • מעיינים במאגר הידע.
  • יש לעדכן את המדריכים ומדריכי השימוש לגרסת Mautic 3x.
  • יצירת משאבים למאגר הידע החדש של Mautic Community Knowledgebase
  • כתבו סדרה של מדריכי הדרכה ומדריכים שיעזרו למשתמשי Mautic להיות יעילים יותר בהגדרה, בהגדרה ובשימוש של האפליקציה.
  • צריך לעדכן את סרטון ההדרכה כך שיתאים לגרסת Mautic 3x.
  • יש להסיר תמונות ומידע ישנים.
  • לשכתב את בסיס הידע כדי שיהיה קל יותר להבין אותו.
  • חשוב להקפיד על הטמעה נכונה של מדריך הסגנון/הדפוס של תיעוד מאגר הידע.

ציר הזמן

לפני 1 באוגוסט

  • להמשיך לתרום לארגון.
  • היכרות טובה יותר עם התיעוד של מאגר הידע והגרסה הנוכחית של Mautic.
  • נלמד טכניקות חדשות ומיומנויות כתיבה טכניות שיעזרו לכם ליישם את הפרויקט.

גיבוש קהילה (1 באוגוסט עד 1 בספטמבר)

  • הגדרת שעה וערוץ תקשורת (בגלל הפרשי שעות)
  • לשפר את היעדים ולהגדיר ציפיות משני הצדדים
  • למידע נוסף על הקהילה והמוצר
  • דיון על מבנה המסמכים המוצע עם המנטורים וחברים אחרים בארגון.
  • השלם את התכונות המוצעות ושינויים אחרים שיש לבצע בתיעוד הקיים.

תקופת התיעוד

  • שבוע 1 (2 בספטמבר עד 22 בנובמבר)
  • במהלך התקופות האלה עבדתי ישירות עם המנטורים שלי כדי :
  • מעיינים במאגר הידע.
  • יש לעדכן את המדריכים ומדריכי השימוש לגרסת Mautic 3x.
  • יצירת משאבים למאגר הידע החדש של Mautic Community Knowledgebase
  • כתבו סדרה של מדריכי הדרכה ומדריכים שיעזרו למשתמשי Mautic להיות יעילים יותר בהגדרה, בהגדרה ובשימוש של האפליקציה.
  • צריך לעדכן את סרטון ההדרכה כך שיתאים לגרסת Mautic 3x.
  • יש להסיר תמונות ומידע ישנים.
  • לשכתב את בסיס הידע כדי שיהיה קל יותר להבין אותו.
  • חשוב להקפיד על הטמעה נכונה של מדריך הסגנון/הדפוס של תיעוד מאגר הידע.
  • תוך התחשבות בקצב ההשקות, צוות הפיתוח יהיה עסוק מאוד בהשקות של תכונות משניות

הערכת פרויקט (25 בנובמבר - 29 בנובמבר 2019)

  • שליחת דוח פרויקט וביצוע הערכה על ידי המנטורים שלי
  • כתבו ושלחו דיווח על החוויה שלי כמשתתף בעונה של Docs.