בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- INCF
- כותבים טכניים:
- hq
- שם הפרויקט:
- מסמכי הדרכה של LORIS למדעי המוח הניתנים לשחזור ופתוחים
- אורך הפרויקט:
- ריצה ארוכה (5 חודשים)
תיאור הפרויקט
ט. מופשט
מערכת המחקר והדימות אונליין (LORIS) היא פלטפורמה מבוססת-אינטרנט לניהול פרויקטים של מחקר בתחום הדמיית המוח,שתומכת בכמה יוזמות של מדע פתוח. המסמכים ממלאים תפקיד חשוב ב-LORIS. באופן ספציפי, התיעוד עוזר למשתמשים ולמפתחים של LORIS להבין את פרטי התוכנה כדי שיוכלו להשתמש טוב יותר בפלטפורמה או לתרום לפיתוח התוכנה. בינתיים, צריך לעדכן גם את המסמכים של LORIS. הפרויקט הזה נועד לעזור ל-LORIS לשפר את התיעוד שלה.
2. מצב נוכחי
בשלב הזה, כל המסמכים של LORIS מתארחים ב-Github Wiki, ב-Read the Docs ובאתר LORIS.ca. באופן ספציפי, ה-Wiki של LORIS ב-GitHub מארח את כמות המסמכים הגדולה ביותר של LORIS, ומדריכים, מצגות, מדריכי משתמשים והדרכות נוספות של LORIS מתארחים במגוון פלטפורמות . מסמכי התיעוד הנוכחיים של LORIS מספקים מדריכים למפתחים ולמשתמשים של LORIS, אבל הם יכולים להפיק תועלת מעוד פיתוח וארגון, במיוחד בעדכוני מסמכי התיעוד ושיפורים בפרטים הטכניים.
III. היתרונות לקהילה
שיפור מסמכי ההדרכה של LORIS בנושא מדעי המוח הניתנים לשחזור פתוח יאפשר לחוקרים ולמפתחים ליהנות מכלים ידידותיים יותר למשתמש, כדי לשפר את איסוף הנתונים במחקרים שלהם. באופן ספציפי, במסגרת הפרויקט יכולים להתבצע עדכונים ושיפורים במסמכי ההתקנה/ההגדרה של LORIS, וכן בחומרים למשתמשי קצה שמספקים הדרכה למשתמשים חדשים. בנוסף, המטרה של הפרויקט היא לעזור בהעברה ובעדכון של מסמכי העזרה מ-LORIS GitHub wiki אל Read the Docs. בינתיים, הפרויקט עשוי לספק תרשים של מסד נתונים כדי להעביר את יחסי הנתונים ולשפר את הוויזואליזציה של הארכיטקטורה. לבסוף, הפרויקט הזה יעדכן וישפר את התוכן שבו אנשים יכירו את LORIS, את ההקשר המדעי הפתוח ואת התרחישים לדוגמה שלה.
IV. חוזקות אישיות בפרויקט
בשנים האחרונות השתתפתי בכמה פרויקטים טכניים, שבזכותם צברתי רקע חזק בכתיבה טכנית. באופן ספציפי, הייתי אחראי על כתיבת מסמכי תיעוד בכמה פרויקטים קודמים של צוותים, ולדעתי יש לי מספיק ניסיון בשימוש בכלים לכתיבת טכנית כמו Read the Docs, Sphinx, Mkdocs, markdown, LaTeX וכו'. בנוסף, ניסיון ההוראה הקודם שלי בקורסים בתחומי STEM שיפר גם את כישורי בתקשורת טכנית. מסמכי ההדרכה של LORIS לפרויקטים פתוחים של מדעי המוח שניתן לשחזור עם INCF יהיו הזדמנות מצוינת להחיל את שיטות הכתיבה הטכנית שלי על LORIS. בנוסף, תחום הדמיית המוח מעניין אותי מאוד ואני מנסה למצוא הזדמנויות להחיל את הידע הטכני שלי על התחום הזה. מסמכי ההדרכה של LORIS לפרויקטים פתוחים וניתנים לשחזור בתחום מדעי המוח עם INCF יהיו לי כהוויה משמעותית.
5. פריטים נדרשים
- העברה ועדכון של המסמכים הנוכחיים של LORIS
- בדיקה, עדכון ושיפור של תיעוד ההתקנה/ההגדרה של LORIS, ומילוי פערים בחומרים של משתמשי קצה שמספקים הדרכה למשתמשים חדשים
- יצירת תרשים של מסד נתונים כדי להציג את הקשרים בין הנתונים (למשל, נושא, ביקור למטרת מחקר) ולשפר את התצוגה החזותית של הארכיטקטורה
- עזרה בעדכון ובשיפור של מסמכי התיעוד של LORIS API
- עזרה בעדכון ובשיפור התוכן שמציג את LORIS, את ההקשר של מדע פתוח ואת תרחישים לדוגמה, שכוללים כמה פורמטים של מדיה
VI. ציר הזמן
היכרות עם הקהילה (17 באוגוסט עד 13 בספטמבר) א) היכרות מלאה עם תוכנת LORIS ותהליך העבודה של הצוות. ב) בדיקה, עדכון ושיפור של מסמכי התיעוד של התקנה/הגדרה של LORIS.
שבוע 1 (14 בספטמבר עד 20 בספטמבר) עדכון והעברה של מסמכי LORIS מ-GitHub wiki לקריאת המסמכים.
שבוע 2 (21 בספטמבר עד 27 בספטמבר) א) בודקים את חומרי ה-LORIS הנוכחיים למשתמשי קצה. ב) מתחילים למלא את הפערים בחומרים למשתמשי קצה של LORIS, ומספקים הדרכה למשתמשים חדשים על סמך המסמכים הקיימים.
שבוע 3 (28 בספטמבר עד 4 באוקטובר) משלימים את החוסרים בחומרים של LORIS למשתמשי קצה, ומספקים הדרכה למשתמשים חדשים.
שבוע 4 (5 באוקטובר עד 11 באוקטובר) א) הבנת הארכיטקטורה הנוכחית של מסד הנתונים של LORIS. ב) תחילת ההטמעה של תרשים מסד הנתונים בפלטפורמת LORIS.
שבוע 5 (12 באוקטובר עד 18 באוקטובר) א) סיום המשימה ליצירת תרשים של מסד הנתונים LORIS. ב) עיון בממשק ה-API הנוכחי של LORIS ותחילת שיפור מסמכי ה-API.
שבוע 6 (19 באוקטובר עד 25 באוקטובר) המשך העבודה על שיפור מסמכי התיעוד של LORIS API.
שבוע 7 (26 באוקטובר עד 1 בנובמבר) סיום השיפורים במסמכי התיעוד של LORIS API.
שבוע 8 (2 בנובמבר עד 8 בנובמבר) בודקים את התוכן הנוכחי שמציג אנשים ללORIS ומתחילים לעדכן ולשפר את ההקשר המדעי הפתוח.
שבוע 9 (9 בנובמבר עד 15 בנובמבר) סיום העדכונים והשיפורים של ההקשר של מדע פתוח בתוכן של הצגת LORIS לאנשים.
שבוע 10 (16 עד 22 בנובמבר) עזרה בעדכון ושיפור של חלק מתרחישי השימוש בתוכן שמציג את LORIS לאנשים.
שבוע 11 (23 בנובמבר עד 29 בנובמבר) עליך להשלים את העדכון והשיפור של כל התרחישים לדוגמה בתוכן שמכניס אנשים ל-LORIS.
סיום הפרויקט (30 בנובמבר עד 5 בדצמבר) א) ניקוי כל התרומות שלי למסמכי העזרה. ב) מיזוג כל בקשות המשיכה שיצרתי ב-GitHub וסגירת כל הבעיות שיצרתי. ג) סיום הדוח הסופי של הפרויקט ושליחת הדוח ל-Google.
VII. פריטים נדרשים עתידיים
אחרי Google Season of Docs 2020, אני רוצה להמשיך לתרום למסמכי העזרה של LORIS. אני רוצה לדון באופן ספציפי עם מפתחים של LORIS לגבי האפשרות להמשיך לעדכן וליצור תיעוד לגרסאות חדשות. בנוסף, אני רוצה להקדיש זמן נוסף לבדיקה של מסמכי התיעוד שיצרתי במהלך הפרויקט שלי ב-Google Season of Docs, ולבדוק אם יש עוד מקום לשיפור. לסיום, יש לי רקע הנדסי רלוונטי ואני מוכן לתרום בעתיד להיבטים אחרים של תוכנת LORIS, למשל פיתוח תוכנה.