تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- CERN-HSF
- الكاتب التقني:
- LuckInTheRain
- اسم المشروع:
- توسيع نطاق مستندات ROOT وتحسينها
- مدة المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
يهدف المشروع إلى تحسين توثيق 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.
- سيتم تضمين بعض المواضيع والتطويرات الجديدة مع أوصاف وأمثلة تفصيلية.
من بين ما يمكنني إدراجه:
- الربط بايثون
- المكتبات الرياضية
- وصف يدوي لأدوات الرسومات عالية المستوى (TRatioPLot وTHStack)
- أدوات تحليل التنقيب عن البيانات الجديدة (RDataFrame وRNtuple)
- تحتاج تنسيقات البيانات الرئيسية الجديدة (RDataFrame وRNtuple) إلى مواصفات فنية مفصلة وبرامج تعليمية.
يجب تضمين الإجابات عن الأسئلة المهمة من المستخدمين، مثل الأسئلة المنشورة في منتدى ROOT، في المستندات. ويتطلب هذا تحليلاً جيدًا للأسئلة الأكثر شيوعًا متبوعة بفترة تجميع لترجمتها إلى أجزاء من الوثائق في "دليل الجذر" الجديد أو في بعض البرامج التعليمية الجديدة في الدليل المرجعي.
برامج تعليمية توضح الوظائف التي يوفرها ROOT 7
- مدرجات تكرارية جديدة ROOT 7
- رسومات ROOT 7 جديدة
الجدول الزمني المقدّر (5 أشهر):
- المرحلة 1: تحديد مهام ونطاق مستندات ROOT والبرامج التعليمية: أسبوعان.
- المرحلة 2: جمع أسئلة المستخدمين المهمة وتحليلها من منتدى ROOT: أسبوعان
- المرحلة 3: كتابة مستند الجذر: 8 أسابيع.
- المرحلة 4: إعداد البرامج التعليمية: 8 أسابيع
أخيرًا، أود أن أضيف أنني ساهمت بالفعل في وثائق ROOT العام الماضي من خلال مشروع طويل المدى لـ Google Season of Docs. لقد حددت البنية الجديدة للدليل. سيساهم الاقتراح هذا العام في إكمال جوانب التوثيق الأخرى التي لا تزال غير موجودة في ROOT.