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