تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- لغة جوليا
- الكاتب التقني:
- mkg33
- اسم المشروع:
- المستندات الموحّدة للتعلُّم الآلي العلمي
- مدة المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
أودّ العمل على توحيد مؤسسة SciML لأنّ هناك مجالاً كبيرًا للتحسين في هذا المجال، وأنّ إكمال هذا المشروع سيوفّر بلا شك فوائد فورية لكل من مبرمجي "جوليا" والمساهمين/العاملين النشطين في تطبيق SciML. تقدم الحزم المنتشرة في SciML بعض الأدوات المفيدة حقًا، ولكن هناك دائمًا خطر من أنها قد تمر بدون ملاحظتها (خاصةً من قبل المستخدمين الجدد) لمجرد أن المستخدم لم يتمكن من اكتشاف الحزمة وتطبيقها على المشكلة المطروحة.
هذا أمر محبط إلى حد ما نظرًا لأن الغرض الأساسي من الحزم هو الوصول إلى جمهور كبير من المبرمجين (المبتدئين والخبراء على حد سواء). لتجنب الموقف المذكور أعلاه، أقترح مراجعة "الصفحة الأمامية" لوثائق SciML بدقة وإنشاء نوع من الموزعات التي يمكن للمستخدمين استخدامها لتصفح الحزم ذات الصلة واستكشاف المنظومة المتكاملة المتنامية. يمكن أن يكون أيضًا بمثابة نقطة مرجعية قيّمة للمستخدمين الأكثر خبرة ويسمح لهم بالعمل بكفاءة أكبر.
أولاً، يجب مراجعة الوثائق الحالية لجميع الحزم الفردية في ما يتعلق بالمشكلات الأسلوبية الأساسية (مثل التهجئة وعلامات الترقيم والقواعد النحوية وما إلى ذلك). لضمان الاتساق الأسلوبي، يحتاج SciML إلى دليل أسلوب ملموس (لا غنى عنه لإجراء تغييرات جلسة مراجعة وللرجوع إليها في المستقبل). سيكون مضيعة الوقت للبدء من الصفر. بدلاً من ذلك، يجب أن تستند إلى اصطلاحات جوليا الحالية وأن تتضمن معلومات جديدة للمشكلات الخاصة بمنصة SciML.
بمجرد اكتمال دليل الأسلوب، أنوي مراجعة الوثائق الحالية في المرحلة الثانية من المشروع. سيجعل التوثيق يبدو أكثر احترافية واستقرارًا. لقد أنشأتُ بالفعل العديد من طلبات السحب التي توضح أسلوبي في التعامل مع هذه المهمة. وفي هذه المرحلة، أنوي ابتكار (وتنفيذ) نظام توثيق فعّال. ستكون المهمة الأولى هي تعديل صفحة الاقتباسات القديمة.
ستشمل المرحلة الثالثة، التي ربما تكون الأكثر أهمية، تصميم خارطة طريق SciML، والتي ستؤكد على التفاعل بين الحزم المبعثرة. كلما كان الترابط أقوى بين حزمتين (فيما يتعلق بالمشكلة أو التعليمة البرمجية نفسها)، كلما ازداد الترابط بين هاتين الحزمتين في قائمة "انظر أيضًا". أقترح إنشاء مفتاحَي توصية: أحدهما لتشابه التعليمات البرمجية والآخر لتشابه المشكلات. وبهذه الطريقة، سيكون المستخدمون قادرين على تحديد الحزم الأخرى التي قد تكون مفيدة بشكل أسرع بكثير من تصفُّح المستودعات والوثائق ذات الصلة. بدلاً من سرد جميع الاتصالات الممكنة بين الحزم، فأنا أفضل أن أركز على الحزم الأكبر ومحاولة تقديم روابطها بحزم أصغر (سيتم توسيع هذه الطريقة أيضًا إلى تحديث البرامج التعليمية حيث يجب الإشارة إلى الاتصال بحزمة أخرى). يضمن هذا النهج أن قوائم "راجع أيضًا" ستكون مفيدة بدون أن تشمل تعدادات شاملة لمجموعات الحزم.