דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- CERN-HSF
- כתב טכני:
- LuckInTheRain
- שם הפרויקט:
- הרחבה ושיפור של מסמכי התיעוד של ROOT
- אורך הפרויקט:
- תקופה ארוכה (5 חודשים)
תיאור הפרויקט
מטרת הפרויקט היא לשפר את התיעוד של ROOT, שהיא מערכת התוכנה הראשית לניתוח נתונים ולהצגת נתונים שמשמשים את קהילת הפיזיקה הקדומה בכל העולם.
מלבד כישורי הכתיבה הטכניים שיש לי בשביל הפרויקט, יש לי גם ידע לגבי ROOT (6 ו-7) ויש לי ידע על רכיבים אחרים שנדרשים לפרויקט, כמו:
- C++
- Python
- Git/GitHub
- כלים לבניית אתרי אינטרנט (html, Markdown, Jekyll)
אני מזהה שלושה חלקים עיקריים במסמכי התיעוד של ROOT:
- באתר https://root.crn,
- מדריך העזר לכיתת C++ https://root.crn/doc/master/,
- הפורום https://root-forum.crn.ch
נראה לי שיש לשפר את התיעוד של ROOT ("המדריך החדש של ROOT") ולהוסיף לו מידע בתחומים הבאים:
- הוא צריך להיות נגיש ומובן יותר לאנשים שאינם פיזיקאים, ובמיוחד בפרקי המבוא.
- אנחנו מפתחים מדריכים נוספים שמסבירים את הפונקציונליות הכללית של ROOT.
- בין היתר, יוצגו נושאים ופיתוחים חדשים ביחד עם תיאורים מפורטים ודוגמאות.
בין היתר, אפשר לציין:
- קישור Python
- הספריות המתמטיות
- תיאור ידני של כלי גרפיקה ברמה גבוהה (TRatioPLot, THStack)
- הכלים החדשים לניתוח כריית נתונים (RDataFrame ו-RNtuple)
- לפורמטים החדשים של נתוני המפתח (RDataFrame ו-RNtuple) נדרשים מפרטים טכניים ומדריכים מפורטים.
במסמכי התיעוד יש לכלול תשובות לשאלות חשובות ממשתמשים, כמו שאלות שפורסמו בפורום ROOT. לשם כך נדרש ניתוח מעמיק של השאלות הנפוצות ביותר ולאחר מכן תקופת סינתזה, כדי לתרגם אותן לקטעי תיעוד ב "מדריך ROOT" החדש או במדריכים חדשים במדריך העזר.
מדריכים להמחשת הפונקציות שמסופקות על ידי ROOT 7.
- 7 היסטוגרמות חדשות של ROOT
- גרפיקה חדשה של ROOT 7
לוח זמנים משוער (5 חודשים):
- שלב 1: הגדרה של משימות והיקף לתיעוד ולמדריכים של ROOT: שבועיים.
- שלב 2: איסוף וניתוח של שאלות חשובות של משתמשים מפורום ROOT: שבועיים
- שלב 3: כתיבת תיעוד ROOT: 8 שבועות.
- שלב 4: פיתוח מדריכים: 8 שבועות
לסיום, אני רוצה להוסיף שכבר תרמתי למסמכי ה-ROOT בשנה שעברה באמצעות פרויקט ארוך-טווח של Google Channel ב-Google Docs. אני הגדרתי את המבנה החדש של המדריך. ההצעה השנה תתרום להשלמת היבטי התיעוד האחרים שעדיין חסרים ב-ROOT.