בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Kolibri
- כותבים טכניים:
- דניאל וי
- שם הפרויקט:
- תהליכי עבודה לניהול תוכן ב-Kolibri
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
ההצעה הבאה נוצרה על סמך מחקר ושיחות עם מנחי Kolibri. השיחה שלי עם המנטורים עזרה לי לפתח את דמויות המשתמש שאדבר עליהן בהמשך. בנוסף, השיחות עזרו לי לחשוב על הרעיון של מאגר הדרכות או דף נחיתה, כדי שלמשתמשים תהיה אפשרות לבחור את המדריך שהכי מתאים לצרכים שלהם.
סקירה כללית
ההצעה הזו מציגה פתרון להדרכה של תהליכי השימוש השונים שאדם יכול לעבור כדי לייבא תוכן מהמחשב שלו ל-Kolibri Studio, ולאחר מכן מ-Kolibri Studio ל-Kolibri. אני מציע ליצור מאגר מרכזי של מדריכים. המשתמשים יגיעו למדריכים האלה דרך דף נחיתה. בדף הנחיתה יוצג טבלה עם קישורים לכל הדרכה לגבי תהליך עבודה, ויצוין סוג המשתמש שיכול להפיק תועלת מההדרכה. כך ההדרכות יהיו מותאמות אישית יותר לצרכים וליכולות של המשתמש. תהליך עבודה (לדוגמה, התקנה-ייבוא) מוצג במספר שיעורים. כל שיעור מכיל סרטון. בסרטונים מוצג חלק קטן מתהליך העבודה, ומוסבר איך תהליכי העבודה האלה מקשרים בין אפליקציות Kolibri.
היעדים העיקריים
כדאי ליצור דף נחיתה של מדריך שיעזור למשתמשים להחליט איזה תהליך עבודה הכי מתאים לצרכים שלהם. דף הנחיתה הזה יארח בפלטפורמה של Read the Docs.
כדאי ליצור שיעורים נפרדים למרכיבים של כל תהליך עבודה, ולהוסיף תרגילים לשיעורים קשים.
יוצרים סרטונים אינטראקטיביים לכל תהליך עבודה.
כלים לפרויקטים
העבודה תבוצע באמצעות תוכנה להקלטת מסך. יש לי ניסיון ב-Camtasia, אבל גם עבדתי עם תוכנות חינמיות וזולות יותר. הסרטון לדוגמה שמקושר כאן (https://youtu.be/DkMP_VdGslU) נוצר באמצעות Flashback על ידי Blueberry Software, שכרגע יש לי רישיון עבורו. אצור כתוביות באמצעות YouTube. דפי ההדרכה יתארחו באתר Read the Docs של Kolibri. טיוטת העבודה תושלם ב-Google Docs, ואוכל לעזור בהמרת קובצי טקסט ל-Markdown או ל-reStructuredText של המוצר הסופי.
ציר הזמן
הפרויקט הזה יתנהל בהתאם להנחיות לפרויקטים לטווח ארוך (סה"כ 26 שבועות, מ-2 בספטמבר 2019 עד 28 בפברואר 2020). אקדיש כ-10 שעות בשבוע להשגת היעדים שמפורטים בהמשך. בנוסף ליעדים האלה, אשתתף בפגישות עם המנטורים ובתקשורת איתם במהלך התקופה הזו, לפי הצורך. אעבוד עם המנטורים כדי לקבוע את המועד המתאים ביותר. ציר הזמן בדרך כלל מחולק לחלקים של ארבעה שבועות, שבהם אצור כמה סרטונים, דפי הדרכה ותרגילים.
שבוע אחד ושבועיים
יעדים:
- מגדירים במכשיר האישי את האתרים או החשבונות הנדרשים כדי לגשת למידע.
- מתחילים לפתח את המבנה ואת תרשים הזרימה המפורט יותר של דף הנחיתה.
- כדאי לדון עם המנטורים על הסגנון של הסרטונים, לפתח תבנית של מסך פתיחה של סרטון, מוזיקה למלא את הזמן בין הכותרת למסך הסיום ומידע נוסף שצריך לכלול.
- כדאי לבדוק את המסמכים הקיימים ואת מבנה המסמכים כדי לחלץ קישורים לשימוש במשאבים נוספים ובחומרים מפורטים.
שבועות שלישי עד שישי (מדריכים ברמה 1 – למתחילים)
יעדים:
- פיתוח תוכן ושיעורים ראשוניים לתהליך העבודה של התקנה-ייבוא/רמה 1. יוצרים סרטון של תהליכי ההורדה, ההתקנה, ההגדרה והייבוא. פונקציות ה-INSTALL-IMPORT הן הבסיס לתהליכי עבודה רבים אחרים, והן הנפוצות ביותר, ולכן נקדיש חלק גדול מהזמן להשלמת ההדרכות והשיעורים האלה.
- כדאי להתמקד בסוגי המיקומים של IMPORT ולפתח גרפיקה שמדגימה למשתמש איפה הוא יכול לקבל תוכן (ערוצים ציבוריים שקיימים ב-Kolibri Studio) לדף הנחיתה.
- פיתוח סרטונים ותוכן נוספים להרחבות של INSTALL-IMPORT (ערוץ UPDATE). התוספות האלה יכולות גם להופיע בתור מקורות מידע נוספים או קישורים למסמכים קיימים.
- לעבוד על כתוביות לכל סרטון.
- "בודקים" סרטונים ומבקשים משוב מכל מקור מידע זמין בנוגע לנוחות השימוש. הפעולות האלה כוללות בדיקה מחדש של התבנית לסרטונים וקביעת התבנית לסרטונים עתידיים.
שבועות שבע עד עשר (רמה 2 – מעלים תוכן)
יעדים:
- כדאי להתמקד בשיעורים ובסרטונים על תהליכי עבודה לפרופיל היוצר שמשתמש בכלי ההעלאה של Studio.
- מסמכי עזרה ומדריכים מלאים בנושא UPLOAD-PUBLISH-IMPORT.
- פיתוח כתוביות לכל סרטון.
שבועיים 11 עד 14 (רמה 3 – 'מיקסרים' של תוכן ועורכים)
יעדים:
- חשוב להתמקד בתהליכי העבודה הבאים וליצור תוכן של מדריך/שיעור: UPLOAD-EDIT-PUBLISH-UPDATE ו-EDIT-PUBLISH-UPDATE.
- לפתח כתוביות לסרטונים.
שבועות 15 עד 18
יעדים:
- כפי שציינתי במהלך המחקר שלי לגבי ההצעה הזו, תהליכי עבודה שכוללים את Ricecooker הם בעדיפות נמוכה יותר (סוג CHEFDEV). בהתאם ללוחות הזמנים, אוכל להשתמש בזמן הזה כדי ליצור מדריך ברמה גבוהה שמתייחס למסמכים הקיימים של Ricecooker.
שבועות 19 עד 22
יעדים:
- בשלב הזה, כדאי לבדוק אם יש פערים ולבדוק את הזרימה הנוכחית של כל המדריכים.
- משלימים את הגדרת דף הנחיתה ומתחילים לקשר בין הסרטונים.
- ממירים טיוטות של דפים שנוצרו ב-Google Docs ל-Markdown או ל-reStructuredText, בהתאם להסכמה עם המנטורים.
שבועות 23 עד 25
יעדים:
- בהתאם לזמן, אפשר לסיים עבודה אחרונה על מדריכים מתקדמים בעדיפות נמוכה.
- עריכה של דפי Read the Docs, בדיקת קבצים ובדיקת דקדוק/איות ברגע האחרון.
- בדיקת איכות של קישורים בסרטונים או בדפים אחרים.
שבוע עשרים ושש
השבוע האחרון לפרויקטים ממושכים. אעבוד עם המנטורים כדי לסיים את המשימות של הפרויקט ולשלים את כל המסמכים הנדרשים של Google.
רכיבי המדריך
דף נחיתה של מדריך
המשתמשים יגיעו לדף נחיתה של מדריך באתר Read the Docs של Kolibri, שבו יוצג סיכום קצר של המדריכים השונים שמוצעים לתהליכי עבודה ביצירת תוכן. מטרת הדף הזה היא לספק סקירה כללית קצרה על הסביבה העסקית של Kolibri, וגם תצוגה גרפית של תהליכי העבודה השונים. כך המשתמש יכול לראות את סוג תהליך העבודה שמתאים לצרכים שלו, גם מבחינה טכנית וגם מבחינת תוכנית הלימודים של הארגון. למשתמשים תהיה הבנה טובה יותר לגבי האפשרויות הזמינות להם ב-Colibri וב-Kolibri Studio.
דפי מדריכים ושיעורים
בכל דף בית של מדריך יוצג מבוא למדריך (שמורכב מכמה שיעורים) ואחריו כמה יעדים למשתמש. המדריכים ממחישים תהליך עבודה שלם ומורכבים משיעורים נפרדים. לכל שיעור יהיה סרטון. הסרטונים יכסו חלק ספציפי מהקונספט הכללי. כל שיעור יישמר בדף נפרד בדף ההורה של תהליך העבודה במדריך. בדפי השיעורים יהיו לחצנים שמאפשרים למשתמש לנווט לשיעור הקודם או הבא במדריך. מושגים מורכבים מאוד יכולים לכלול פעילויות תרגול.
סרטונים ומבנה
הסרטונים יכללו סקירה כללית של מושג אחד. בסרטונים יוצגו הוראות בזמן ביצוע הפעולה במסך. סרטון לדוגמה זמין כאן: https://youtu.be/DkMP_VdGslU. בסרטון לדוגמה הזה מוסבר איך להשתמש באשף להגדרת מתקן.
בסרטון נעשה שימוש בהסברים ובסמן מודגש כדי להנחות את המשתמש בשלבים של הקונספט היחיד הזה. הסרטונים יתארחו ב-YouTube. אם הסרטון מתארח ב-YouTube, הכתוביות נוצרות באופן אוטומטי. לאחר מכן אערוך את הכתוביות מבחינת איות, דקדוק ופיסוק. לאחר מכן תוכלו לייצא את הכתוביות האלה לתרגום ב-Amara או בכלי תרגום אחר.
הסרטונים יכללו מסך כותרת עקבי, ואני מתכוון לדון בנושא הזה עם המנטורים בשבועות הראשונים. בנוסף, אשתמש בסגנון עקבי של תיוג (חיצים, הדגשת הסמן, תיבות), שנקבע יחד עם המנטורים בשבועות הראשונים.
דוגמאות למבנים
תהליך העבודה הפשוט ביותר, INSTALL-IMPORT, הוא מדריך שלם. במדריך הזה יש שני שיעורים אפשריים עם סרטון:
- הורדה, התקנה והגדרה של Kolibri Facility
- ייבוא תוכן ב-Kolibri Studio – הערה: תהליכי עבודה אחרים יפנו לסרטון הזה
כדי ליצור הדרכה מתקדמת יותר, צריך ליצור כמה שיעורים משניים עם כמה סרטונים. תהליך העבודה UPLOAD-EDIT-PUBLISH-UPDATE מתבצע לפי המבנה הבא.
שיעור 1 – העלאת תוכן ויצירת ערוצים ב-Kolibri Studio
מטרות עסקיות למשתמש: בסיום השיעור הזה, תלמדו איך לבצע את הפעולות הבאות:
- יצירת ערוצים ב-Kolibri Studio לשימוש ב-Kolibri. תלמדו איך להשתמש באסימונים הסודיים של הערוץ כדי לייבא את ערוץ התוכן שלכם ב-Kolibri.
- כדי ליצור ערוץ, אפשר לייבא תוכן מערוצים ציבוריים קיימים מספריית Studio.
- כדי ליצור ערוץ, צריך להעלות תוכן מהמחשב.
סרטונים של שיעורים משניים:
- שיעור משנה 1 – יצירת ערוצים משלכם ב-Kolibri Studio וייבוא תוכן מערוצים ציבוריים קיימים (Khan Academy, PHET וכו'): סרטון 1 – ערוצי תוכן ציבורי (צפייה בערוצים ציבוריים ב-Kolibri Studio) סרטון 2 – יצירת ערוץ סרטון 3 – ייבוא תוכן מערוצים קיימים סרטון 4 – פרסום הערוץ והשגת האסימון הסודי סרטון 5 – ייבוא הערוץ ל-Kolibri באמצעות האסימון הסודי
- שיעור משנה 2 – העלאה של ערוץ תוכן ב'המסמכים שלי': סרטון 1 – העלאת קבצים מהמסמכים שלי סרטון 2 – יצירת תרגילים משלכם
שיעור 2 – עריכה מתקדמת של ערוצים ב-Kolibri Studio
מטרות עסקיות למשתמש: בסוף השיעור הזה תלמדו איך לבצע את הפעולות הבאות:
- עריכת ערוצי תוכן ב-Kolibri Studio
- ניהול ערוצי תוכן ב-Kolibri Studio
סרטוני שיעור משנה:
- שיעור משנה 1 – עריכת תוכן על ידי הוספת תרגילים, ארגון מחדש של מבנה התיקיות ואפשרויות שיתוף פעולה (סרטון אחד)
- שיעור משנה 2 – שימוש בפונקציות אחרות, כמו מחיקה או העברה של תוכן (סרטון אחד)
שיעור 3 – פרסום ערוצים של Kolibri Studio לשימוש ב-Kolibri ועדכון ערוצים
מטרות עסקיות למשתמש: בסיום השיעור הזה, תלמדו איך לבצע את הפעולות הבאות:
- איך מפרסמים ערוץ ב-Kolibri Studio ומפרסמים אותו מחדש אחרי שמוסיפים תוכן חדש
- עדכון ערוץ
- קבלת אסימון ערוץ כדי לייבא אותו ל-Kolibri (דרך קישור לסרטון הקודם בשיעור 1, שבו מוסבר איך לבצע את הפעולה הזו)
סרטוני שיעור משנה:
שיעור משנה 1 – פרסום עדכונים בערוץ
סרטון 1: פרסום מחדש של הערוץ סרטון 2: עדכון הערוץ ב-Kolibri אחרי הוספת תוכן נוסף