פרויקט INCF

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

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

ארגון הקוד הפתוח:

INCF

כתב טכני:

שע'

שם הפרויקט:

מסמכי הדרכה של LORIS בנושא מדעי המוח שניתנים לשחזור

אורך הפרויקט:

תקופה ארוכה (5 חודשים)

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

I. מופשט

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

2. מצב נוכחי

כיום LORIS משתמש ב-GitHub Wiki, ב-Read the Docs ובאתר של LORIS.ca לאירוח כל התיעוד. באופן ספציפי, הוויקי של LORIS GitHub Wiki מארח את הכמות הגדולה ביותר של תיעוד של 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 יכולים לספק לי חוויה חשובה.

ה. חומרים נדרשים

1. העברה ועדכון של תיעוד LORIS הנוכחי
2. בדיקה, עדכון ושיפור של תיעוד ההתקנה וההגדרה של LORIS ומילוי פערים בחומרים למשתמשי קצה המספקים הדרכה למשתמשים חדשים
3. עזרה ביצירת דיאגרמת מסד נתונים לצורך העברת קשרי נתונים (למשל נושא, ביקור במחקר) ושיפור ההמחשה החזותית של ארכיטקטורה
4. רוצה לעזור בעדכון ובשיפור של התיעוד של LORIS API?
5. עזרה בעדכון ושיפור של תוכן המציג אנשים ל-LORIS, ההקשר המדעי הפתוח שלו ומקרי השימוש שלו, הכוללים פורמטים שונים של מדיה

VI. ציר הזמן

שיתוף מידע קהילתי (17 באוגוסט עד 13 בספטמבר) א) היכרות עם התוכנה של LORIS ותהליך העבודה של הצוות. ב) בדיקה, עדכון ושיפור התיעוד של התקנה/הגדרה של LORIS.

שבוע 1 (14 בספטמבר עד 20 בספטמבר) עדכון והעברה של תיעוד LORIS מ-wiki של GitHub לקריאת Docs.

שבוע 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 בנובמבר) בדיקת התוכן הנוכחי שמציג אנשים ל-LORIS והתחילו לעדכן ולשפר את ההקשר המדעי הפתוח.

שבוע 9 (9 בנובמבר עד 15 בנובמבר) סיום עדכונים ושיפורים בהקשר מדעי פתוח בתוכן של הצגת אנשים ל-LORIS.

שבוע 10 (16 בנובמבר עד 22 בנובמבר) עזרה בעדכון ובשיפור של חלק מתרחישי השימוש בתוכן שמציג אנשים ל-LORIS.

שבוע 11 (23 בנובמבר עד 29 בנובמבר) עליך להשלים את העדכון והשיפור של כל תרחישי השימוש בתוכן שמציג אנשים ל-LORIS.

'השלמת הפרויקט' (30 בנובמבר - 5 בדצמבר) א) למחוק את כל מסמכי התיעוד שיצרתי. ב) למזג את כל בקשות השליפה שנוצרו ב-GitHub ולסגור את כל הבעיות שיצרתי. ג) לסיים את דוח הפרויקט הסופי ולשלוח את הדוח ל-Google.

VII. פריטים עתידיים

אחרי העונה של Google Docs 2020, אמשיך לתרום לתיעוד של LORIS. באופן ספציפי, אני רוצה לדון עם מפתחי LORIS לגבי האפשרות להמשיך בעדכון וביצירת מסמכים עבור גרסאות חדשות. בנוסף, אני רוצה להקדיש זמן נוסף כדי לעיין במסמכים שיצרתי במהלך הפרויקט שלי ב'עונת Google' ב-Docs ולבדוק אם יש מקום לשיפור. לסיום, מכיוון שיש לי רקע הנדסי רלוונטי, אני פתוח לתרום להיבטים אחרים של תוכנת LORIS, למשל, פיתוח תוכנה.