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