דף זה מכיל את הפרטים של פרויקט כתיבה טכני שהתקבל בעונת Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- CERN-HSF
- כתב טכני:
- ישראל
- שם הפרויקט:
- CERN-HSF – מסמכי ROOT לאימוץ הקהל הכללי, קישורים דינמיים ב-Python ומדריכים
- אורך הפרויקט:
- משך זמן ארוך (5 חודשים)
תיאור הפרויקט
CERN-HSF – תיעוד ROOT לאימוץ הקהל הרחב, קישור דינמי של Python ומדריכים מנטור: אוליבייה קואט, אקסל נאומן
תקציר: התיעוד הוא חיוני לאימוץ התוכנה באופן מוצלח ויעיל על ידי המשתמשים. תיעוד ברור, מדויק ומקיף של המשתמשים, שמאפשר למשתמשים לתרגל את מיומנות השימוש בתוכנה בזמן שהם שואפים להשיג את מטרותיהם. דוגמאות מפורשות ומדריכים הם כלים רבי עוצמה שבעזרתם המשתמשים יכולים ללמוד במהירות.
כשאנחנו בוחנים את השימוש ב-ROOT על ידי פיזיקאים, חוקרים ומפתחים בתחום ניתוח הנתונים וההדמיה בתחום הפיזיקה, יש הכרה ביתרונות של תיעוד ידידותי למשתמש ומעודכן. לאור ההיקף הנרחב של קוד המקור והצמיחה שלו, מערכת התיעוד נהנית מפיתוח מקביל כדי להעניק למשתמשים את היכולת להפיק את המקסימום מ-ROOT.
סיכום וניתוח של מסמכי התיעוד העדכניים נכון לעכשיו, במסמכי התיעוד למשתמש יש מדריך שמאפשר לפיזיקאים לאמץ את ROOT בקלות רבה יותר ביחס לקהל הרחב. בנוסף, בתוך נושאים מסוימים, כמו קישור דינמי ל-Python, ניתן לבצע שיפורים כדי ליצור תיעוד מקיף וברור יותר. באופן דומה, לפורמט הנתונים החדש RNTuple חסר מפרטים מפורטים נדרשים. לסיום, בתיעוד הנוכחי חסרים מדריכים שקשורים ל-ROOT 7.
מתודולוגיה: לאחר שיחת הייעוץ עם אוליבייה, נראה שכדי לטפל בבעיות שהוזכרו למעלה, ההתמקדות העיקרית צריכה להיות זיהוי פערי ידע בין חוקרים מומחים לקהל הרחב, יצירת מסמכים שיגשרו על הפער הזה, כתיבת תיעוד מפורט יותר של קישורים דינמיים ב-Python, הטמעת 'מדריכים לניתוח מודרני' עבור ROOT 7 ויצירת מפרטים טכניים מפורטים ל-RNTuple. לאורך התהליך הזה, ניתן יהיה בתיעוד לשלב מסמכי notebook של Jupyter כדי לאפשר למשתמשים להשתמש בכלי למידה מוחשי ואינטראקטיבי.
ציר הזמן: שלבי הפרויקט המשוערים הם: זיהוי פערי ידע בין חוקרים מומחים לבין קהל כללי (תוך עיון במסמכי התיעוד הנוכחיים ובקוד המקור) ← 1-2 שבועות יצירה וארגון מחדש של התיעוד כדי לגשר על הפער ← 3 שבועות כתוב תיעוד מפורט יותר של קישור דינמי של Python ← 3 שבועות להטמעת מפרטים להטמעה של Python
תוצרים וקווים מנחים להצלחה: תיעוד מאוחד למשתמש יחיד ללא פערים תיעוד משתמש מעודכן לחלוטין, שמשקף את התכונות העדכניות ביותר, כלומר כיתות נגזרות חדשות מדריכים דרך notebooks של Jupyter