تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- CERN-HSF
- الكاتب التقني:
- جون
- اسم المشروع:
- CERN-HSF - وثائق جذرية لاعتماد الجمهور العام وروابط Python الديناميكية والبرامج التعليمية
- مدة المشروع:
- مدّة طويلة (5 أشهر)
وصف المشروع
CERN-HSF - ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials Mentor: Olivier Couet, Axel Naumann
الملخّص: إنّ المستندات ضرورية لاعتماد المستخدمين للبرامج بنجاح وكفاءة. تسهّل مستندات المستخدمين الواضحة والدقيقة والشاملة إتقان المستخدمين للبرنامج أثناء سعيهم لتحقيق أهدافهم. وفي هذا السياق، تُعدّ الأمثلة والأدلة التعليمية الواضحة أدوات فعّالة يمكن للمستخدمين من خلالها التعلّم بسرعة.
بينما ندرس استخدام نظام ROOT من قبل الفيزيائيين والباحثين والمطورين في مجال تحليل البيانات والتصور للفيزياء، هناك إقرار بفوائد الوثائق سهلة الاستخدام والمُحدّثة. وعلى وجه الخصوص، بسبب اتساع رمز المصدر ونموه، يمكن لنظام التوثيق الاستفادة من التطور الموازي لمنح المستخدمين القدرة على الاستفادة إلى أقصى حد من كل ما تقدّمه ROOT.
ملخّص وتحليل للمستندات الحالية تقدّم مستندات المستخدم حاليًا دليلاً يتيح للفيزيائيين استخدام ROOT بسهولة أكبر مقارنةً بالجمهور العام. علاوة على ذلك، يمكن إجراء تحسينات في بعض المواضيع مثل روابط بايثون الديناميكية، للحصول على وثائق أكثر شمولاً ووضوحًا. وبالمثل، يفتقر تنسيق البيانات الجديد RNTuple إلى المواصفات التفصيلية اللازمة. أخيرًا، لا تتضمّن المستندات الحالية أدلة تعليمية حول ROOT 7.
المنهجية: بعد التشاور مع "أوليفير"، بدا أنه من أجل معالجة المشكلات المذكورة أعلاه، ينبغي أن يكون التركيز الأساسي على تحديد الفجوات المعرفية بين الباحثين المتخصصين والجمهور العام، وإنشاء وثائق سدّ تلك الفجوة، وكتابة وثائق أكثر تفصيلاً عن "روابط بايثون الديناميكية"، وتنفيذ "برامج تعليمية للتحليل الحديث" لنظام ROOT 7، وإنشاء مواصفات تقنية مفصلة لـ RNTuple. في هذا السياق، يمكن أن تتضمّن المستندات دفاتر ملاحظات Jupyter خلال هذه العملية حتى تتمكّن أدوات التعلّم الملموسة والتفاعلية من مساعدة المستخدمين.
الجدول الزمني: مراحل المشروع مقدرة بأنها: تحديد الفجوات المعرفية بين الباحثين المتخصصين والجمهور العام (أثناء قراءة الوثائق الحالية ورمز المصدر) ← أسبوع إلى أسبوعين إنشاء الوثائق وإعادة هيكلتها لسدّ تلك الفجوة ← 3 أسابيع كتابة وثائق أكثر تفصيلاً عن روابط بايثون الديناميكية ← 3 أسابيع تنفيذ البرامج التعليمية لروابط بايثون الديناميكية ← 4 أسابيع من الانتهاء من البرامج التعليمية
العناصر التي يجب تقديمها وإرشادات لتحقيق النجاح: مستندات المستخدمين الموحدة بدون أي ثغرات مستندات المستخدمين المعدَّلة بالكامل لتعكس أحدث الميزات، أي الفئات المشتقة الجديدة البرامج التعليمية من خلال دفاتر Jupyter