تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- CERN-HSF
- الكاتب التقني:
- جون
- اسم المشروع:
- CERN-HSF: مستندات جذرية حول استخدام الجمهور العام، والارتباطات الديناميكية Python، والبرامج التعليمية
- مدة المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
CERN-HSF - وثائق ROOT لاعتماد الجمهور العام والروابط الديناميكية Python والبرامج التعليمية المرشد: أوليفييه كويت، وأكسل نومان
ملخص: يعد التوثيق أمرًا ضروريًا لاعتماد البرامج بنجاح وفعال من قبل المستخدمين. تساهم وثائق المستخدم الواضحة والدقيقة والشاملة في تسهيل كفاءة المستخدمين في استخدام البرامج أثناء سعيهم لتحقيق أهدافهم. وكذلك، تعمل الأمثلة والبرامج التعليمية الواضحة كأدوات قوية يمكن للمستخدمين التعلم من خلالها بسرعة.
أثناء فحص استخدام ROOT من قبل الفيزياء والباحثين والمطورين في مجال تحليل البيانات والتصور للفيزياء، هناك اعتراف بفوائد الوثائق سهلة الاستخدام والمحدثة. بسبب اتساع رمز المصدر ونموه على وجه الخصوص، يستفيد نظام التوثيق من عملية التطوّر بالتوازي لمنح المستخدمين القدرة على الاستفادة إلى أقصى حد من كل ما يمكن أن يوفّره الجذر.
ملخص وتحليل الوثائق الحالية في الوقت الحالي، تقدم وثائق المستخدم دليلاً يسمح للفيزيائيين بتبني الفيزياء بسهولة أكبر بالنسبة للجمهور العام. وعلاوة على ذلك، يمكن إجراء تحسينات ضمن موضوعات معينة مثل الروابط الديناميكية في بايثون، للحصول على وثائق أكثر شمولاً ووضوح. وبالمثل، يفتقر تنسيق البيانات الجديد RNTuple إلى المواصفات التفصيلية الضرورية. أخيرًا، لا تحتوي الوثائق الحالية على البرامج التعليمية المتعلقة ببرنامج ROOT 7.
المنهجية: بعد إجراء اجتماع مع أوليفييه، بدا أنه من أجل معالجة المشكلات المذكورة أعلاه، ينبغي أن يتضمن التركيز الأساسي تحديد الفجوات المعرفية بين الباحثين المتخصصين والجمهور العام، وإنشاء وثائق لسد تلك الفجوة، وكتابة وثائق أكثر تفصيلاً لعمليات ربط لغة بايثون الديناميكية، وتنفيذ "دروس للتحليل الحديث" لنظام ROOT 7، وإنشاء مواصفات فنية تفصيلية لـ Ruple. بالإضافة إلى ذلك، خلال هذه العملية، يمكن أن تتضمّن الوثائق دفاتر ملاحظات Jupyter بحيث يمكن أن تساعد أدوات التعلم الملموسة والتفاعلية المستخدمين.
الجدول الزمني: تُقدَّر مراحل المشروع على النحو التالي: تحديد الفجوات المعرفية بين الباحثين المتخصصين والجمهور العام (أثناء القراءة من خلال الوثائق الحالية ورمز المصدر) ← من أسبوع إلى أسبوعين إنشاء الوثائق وإعادة صياغتها لسد هذه الفجوة ← 3 أسابيع كتابة وثائق أكثر تفصيلاً لعمليات الربط في لغة بايثون الديناميكية ← ← 3 أسابيع الدروس التعليمية المكتملة لعمليات تنفيذ Python الفنية ← إنشاء برامج تعليمية تفصيلية لـ 4 أسابيع من مشروع بايثون بنجاح ← إنشاء برامج تعليمية تفصيلية لـ 4 أسابيع من مشروع بايثون
المُخرَجات النهائية وإرشادات للنجاح: مستندات موحَّدة للمستخدم بدون أي ثغرات مستندات مستخدم محدَّثة بالكامل لتعكس أحدث الميزات، أي الصفوف المستمدة الجديدة دروس تعليمية من خلال دفاتر ملاحظات Jupyter