تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- OpenMRS
- الكاتب الفني:
- قوس قزح
- اسم المشروع:
- تحسين الوثائق الفنية لمشروع OpenMRS للمطوّرين الجدد
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الأسباب
في ظلّ معاناة العالم من عواقب جائحة فيروس كورونا المستجد (كوفيد-19)، يتضح أكثر أنّ نظام السجلات الطبية المفتوح المصدر، مثل OpenMRS، يمكن أن يكون جزءًا من الحلّ لهذا النوع من الأزمات. لمساعدة المطوّرين الجدد في التنقّل في منظومة OpenMRS المتكاملة وتقصير عملية الإعداد والتأهيل، والسماح لعدد أكبر من الوافدين الجدد بالمساهمة بسرعة في تطوير OpenMRS، من الضروري توفُّر مستندات موجزة وواضحة وحديثة. يتوفّر مستندان حاليان للمطوّرين الجُدد: • بدء العمل كمطوّر • دليل المطوّر ومع ذلك، بعض المحتوى قديم والتنسيق بحاجة إلى تحسين. يهدف هذا المشروع إلى تعديل محتوى هذين المستندَين وتحسين تنسيقهما ليصبحا أكثر سهولة في الاستخدام.
النطاق
- إعادة تنظيم محتوى هذين المستندَين وإعادة تنسيقه بالنسبة إلى مستند "بدء العمل كمطوِّر": أ. قسّم الخطوات السبع عشرة في التعليمات إلى أقسام، يحتوي كل قسم على خطوات أقل، بحيث يسهل على المستخدم متابعتها. ب- إعادة ترتيب الخطوات، حيث يمكن دمج بعض الخطوات ج. أدرِج روابط تؤدي إلى صفحات الموسوعة الأخرى في الجداول، لكي تكون التعليمات أكثر إيجازًا وسهولة في القراءة.
بالنسبة إلى دليل المطوّر: أ. يمكن تقصير معلومات الخلفية حول OpenMRS في الفصول القليلة الأولى، ويمكن توجيه المستخدمين إلى صفحة OpenMRS.org للاطّلاع على مزيد من التفاصيل. ب- يجب نقل فصل "الإعداد" إلى أعلى الصفحة قبل فصل "عملية التطوير".
عدِّل المحتوى. بالنسبة إلى مستند "البدء كمطوّر": أ. تعديل إعدادات البيئة لنظامَي التشغيل Linux وWindows (تقديم Docker) ب. تعديل إعدادات IDE لكل من IntelliJ وEclipse c أدرِج رابطًا يؤدي إلى دليل المطوِّر أو دليل المطوِّر حيثما أمكن. د. تأكَّد من أنّ كل محتوى الرابط مُحدّث.
بالنسبة إلى دليل المطوّر: أ. قدِّم سير عمل التطوير. ب. يمكنك تقديم شرح عن كيفية تنظيم فِرق التطوير وكيفية عمل أعضاء الفريق معًا، وإضافة روابط إلى اجتماعات الفريق ومناقشاته، ومساعدة المطوّرين الجدد في العثور على الفِرق التي قد يريدون الانضمام إليها. ج. أضِف Docker في فصل إعداد النظام. د. أضِف المزيد من التفاصيل حول الأنواع المختلفة من الوحدات (وحدة التطبيق المرجعي ووحدة OWA ووحدة المنصة) وكيفية عملها معًا. أضِف أمثلة بسيطة على الرموز البرمجية لعرض كيفية إنشاء كل نوع من الوحدات ونشره. f. أضِف أمثلة اختبارية بسيطة لكل نوع من الوحدات.
تحليل الجمهور
يستهدف دليل المطوّر ودليل "البدء كمطوّر" المطوّرين الذين لديهم معرفة قليلة أو معدومة ببرنامج OpenMRS. يمكن أن يكون هناك نوعان من المطوّرين: النوع الأول من الجمهور هو المطوّرون المبتدئون الذين لديهم خبرة قليلة أو معدومة في تطوير البرامج. على سبيل المثال، طلاب GSoC الذين يبحثون عن مشاريع حقيقية للتعرّف على تطوير البرامج المفتوحة المصدر. بالنسبة إلى هؤلاء المطوّرين، من المفترض أن تقدّم المستندات التفاصيل والمراجع الكافية ليتمكّنوا من البدء في سدّ الفجوات المعرفية والمساهمة في مشاريع OpenMRS خلال فترة زمنية قصيرة نسبيًا. تتمثل الأهداف الرئيسية للمطورين المبتدئين في ما يلي: 1. فهم المهارات المطلوبة للمشاركة في OpenMRS (MySQL وJava Spring) React.js وGit وما إلى ذلك) والعثور على المراجع اللازمة لتعلُّم هذه المهارات 2. انضم إلى منتدى OpenMRS وتعرَّف على أدوات التواصل. 3- إعداد البيئة وبيئة التطوير المتكاملة 4. ثبِّت حزمة تطوير البرامج (SDK) لنظام OpenMRS. 5- فهم سير عمل التطوير 6- إنشاء رمز بسيط لإنشاء وحدات جديدة 7- نشر الوحدات التي تم إنشاؤها حديثًا 8. وحدات الاختبار: 9. استخدِم Git لتقديم طلبات سحب. النوع الثاني من الجمهور هو المطوّرون من المستوى المتوسط أو كبار المطوّرين الذين يريدون تخصيص OpenMRS لتلبية احتياجات مؤسستهم أو للمساهمة في OpenMRS. وبالنسبة إلى هؤلاء المطورين الأكثر خبرة، يجب أن يقدم المستندان نظرة عامة على OpenMRS ويعملان كدليل لتوجيههم إلى تفاصيل أكثر تفصيلاً عن التكنولوجيا في دليل المطور والموارد الأخرى. في ما يلي الأهداف الرئيسية للمطوّرين المجرّبين: 1- فهم نموذج البيانات وبنية OpenMRS 2 الانضمام إلى منتدى OpenMRS، والتعرّف على أدوات التواصل 3- ابحث عن روابط تؤدي إلى مستودعات الرموز البرمجية في OpenMRS. 4. العثور على مراجع أكثر تفصيلاً
خطة المشروع
مرحلة التخطيط: • تحسين الأهداف المحدّدة في قسم "النطاق" • تحديد المحتوى القديم • إنشاء مخطّطات للوثيقتَين • عرض المخطّط على المرشد والخبراء المختصّين بالموضوع • تعديل خطة المشروع
مرحلة تطوير المحتوى • التعرّف على Docker، وتنفيذ جميع خطوات التثبيت، وإنشاء مثال بسيط على الرمز البرمجي/رمز الاختبار • إجراء مقابلات مع الأنشطة التجارية الصغيرة والمتوسطة الحجم لطرح الأسئلة عليها • وضع المسودة الأولى للمستندَين
مراجعة المحتوى ونشره: • تعديل المحتوى ذاتيًا • إرسال المسودات المكتملة إلى المراجعين (المرشد والمؤسسات الصغيرة والمتوسطة الحجم) والمستخدمين النهائيين للحصول على ملاحظاتهم • مراجعة المسودة • نشر المستندَين في صفحة الموسوعة على OpenMRS • كتابة تقرير المشروع
العمل الأولي
قمت ببعض الأعمال في بيئة تطوير تم إعدادها في نظام Linux وإعداد حزمة OpenMRS SDK. نحن بصدد ضبط IDE. سأواصل العمل على إنشاء وحدات بسيطة وكتابة رمز اختبار.
المراجع والمناقشات
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy-for-new-developer-learner/18861/14 https://talk.openmrs.org/t/looking-for-a-mentor-for-gsod2020-project-improving-documentation-for-new-developers/28999 https://talk.openmrs.org/t/a-possible-new-gsod-2020-project/28947