تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- لغة Julia
- الكاتب الفني:
- شو ليو
- اسم المشروع:
- LightGraphs Docs 2.0 & User-Friendly JuliaGraphs Tutorials
- مدة المشروع:
- الحمل لمدة طويلة (5 أشهر)
وصف المشروع
في هذا المشروع الطويل، سأقوم بتحسين موقع الويب ووثائق الوحدات في JuliaGraphs. سيشمل عملي على وجه التحديد، على سبيل المثال لا الحصر، المحتوى التالي.
LightGraphs Docs 2.0 - 10 أسابيع
- نظرة عامة: LightGraphs.jl هي حزمة رسوم بيانية خفيفة الوزن ومحسّنة لنظام التشغيل Julia، وهي تشكّل جوهر منظومة JuliaGraphs المتكاملة. يمثل الإصدار 2.0 القادم من LightGraphs تغييرًا جوهريًا في واجهة برمجة تطبيقات LightGraphs. سأحرص على أن تعرض المستندات أحدث ميزات LightGraphs وأفضلها.
- النتائج المرجوة: سأُجري تدقيقًا في مستندات واجهة برمجة التطبيقات الحالية لمعرفة المستندات التي يمكن أن تظل كما هي وتحليل التغييرات التي تم إجراؤها في الإصدار 2.0 لضمان توثيقها بشكل صحيح مع تقديم أمثلة. وخلال هذه العملية، سأكتب مشاركات تُبرز التغييرات الرئيسية في الإصدار 2.0. لمساعدة المستخدمين الجدد على فهم LightGraphs بشكل أفضل، سأنشئ أدلة للمبتدئين الذين يخطوون الخطوة الأولى في عالم استخدام الرسوم البيانية في Julia.
- ملاحظات: في هذا المشروع، سيتم استخدام Documenter.jl كمنشئ مستندات لإنشاء مستندات LightGraphs. بالإضافة إلى مراجع واجهة برمجة التطبيقات للوحدات مثل Coloring.jl، أحتاج أيضًا إلى هذه المراجع للوحدات الفرعية مثل greedy_color.jl. سأستكشف كيفية إضافتها لتجديد مستندات LightGraphs. إلى جانب ذلك، فإن نظرية الرسم البياني هي مجال تقني إلى حد كبير للرياضيات وهي غامضة لمن ليس لديهم خلفية رياضية. لقد شاركت في أبحاث أكاديمية لمدة عامين تقريبًا وكتبت العديد من المشاركات على مدونتي الشخصية، لذا أثق في قدرتي على شرح جوهر الخوارزميات المختلفة وتقديم نصائح حول الخوارزميات التي يمكن استخدامها في مواقف مختلفة عند إنشاء أدلة للمبتدئين.
برامج تعليمية حول JuliaGraphs - 10 أسابيع
- نظرة عامة: إنّ العديد من مستندات حِزم JuliaGraphs موجّهة للمطوّرين. سأضيف بعض الأمثلة البسيطة وأوضح استخدام كل ميزة، مما يجعلها أكثر سهولة بالنسبة للمستخدمين.
- المخرجات النهائية: سأقوم بمراجعة برامج LightGraphs التعليمية الحالية لمعرفة المواد التي يجب إضافتها وإثبات استخدام كل ميزة ودوافعها. بعد ذلك، سأتبع أسلوب JuliaGraphsTutorials لتوسيع نطاق أدلة JuliaGraphs التعليمية، بما في ذلك دليل المبتدئين في منظومة LightGraphs المتكاملة.
- ملاحظات: محتوى JuliaGraphsTutorials ليس شاملاً بما يكفي في الوقت الحالي، والمخرجات النهائية المذكورة أعلاه مخصّصة في الغالب لحزمة LightGraphs. إذا سمح الوقت، سأضيف أيضًا أدلة تعليمية للوحدات الأخرى في JuliaGraphs، مثل GraphPlot.jl وMetaGraphs.jl وSimpleWeightedGraphs.jl.
الموقع الإلكتروني لـ JuliaGraphs Central - 4 أسابيع
- نظرة عامة: يوفّر الموقع الإلكتروني المركزي لمجموعة JuliaGraphs نظرة عامة على حِزم المنظومة المتكاملة. ومع ذلك، لا يزال هذا القسم يتضمّن وصفًا بشكل أساسي ويمكن تحسينه أكثر ليصبح المرجع الأول للمستخدمين الذين يبدأون استخدام الرسوم البيانية في Julia. سأبحث عن طريقة سهلة باستخدام العروض المرئية لإبراز ميزات حِزم JuliaGraphs المختلفة.
- التسليمات: سأقدم حالات استخدام وأمثلة لتسليط الضوء على وظائف حزم JuliaGraphs وإجراء تدقيق للتأكد من أنها لا تزال ذات صلة ومدعومة. سأنشئ قسمًا يسلّط الضوء على الاستخدامات المختلفة للحِزم المختلفة في نطاقات مختلفة (الرعاية الصحية والتعليم وما إلى ذلك). إذا سمح الوقت، سأبحث عن تفسيرات مرئية للخوارزميات المستخدَمة في "الرسوم البيانية".
- ملاحظات: تم استخدام العديد من حِزم JuliaGraphs على نطاق واسع في نطاقات مختلفة. إلى جانب إضافات التخطيط مثل DiGraph for NetworkViz، إنّ بعض التطبيقات الأخرى في مواضيع محدّدة سأدرجها هي رسوم بيانية للبنى البيولوجية في علم الأحياء، وDijkstraState for TrafficAssighnment in Urban Planning، وDiGraph for TreeView in Education، ووما إلى ذلك.