تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- CERN-HSF
- الكاتب التقني:
- LuckInTheRain
- اسم المشروع:
- توسيع نطاق مستند ROOT وتحسينه
- طول المشروع:
- الحمل لمدة طويلة (5 أشهر)
وصف المشروع
يهدف المشروع إلى تحسين مستندات ROOT، وهو نظام البرامج الرئيسي لتحليل البيانات وعرضها والذي يستخدمه مجتمع الفيزياء عالية الطاقة في جميع أنحاء العالم.
بالإضافة إلى مهارات الكتابة الفنية التي يمكنني تقديمها للمشروع، أنا أيضًا على دراية بـ ROOT (الإصداران 6 و7) ولديّ معرفة بالمكوّنات الأخرى المطلوبة للمشروع، مثل:
- C++
- Python
- جيت/جيت هب
- أدوات إنشاء المواقع الإلكترونية (html وMarkdown وJekyll)
أحدد ثلاثة أجزاء رئيسية في وثائق ROOT:
- موقع الويب https://root.cern،
- دليل مرجعي لفئة C++ https://root.cern/doc/master/
- المنتدى https://root-forum.cern.ch
يبدو لي أن وثائق 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. حدّدتُ البنية الجديدة للدليل. سيساهم الاقتراح هذا العام في إكمال جوانب مستندية أخرى لا تزال غير متوفّرة في ROOT.