تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- OpenMRS
- الكاتب التقني:
- قوس قزح
- اسم المشروع:
- تحسين المستندات الفنية لخدمة OpenMRS لمطوّري البرامج الجدد
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الأسباب
في ظل مواجهة العالم لعواقب جائحة فيروس كورونا المستجد (كوفيد-19)، بات من الواضح أكثر أنّ نظام سجلّ طبي مفتوح المصدر مثل OpenMRS يمكن أن يكون جزءًا من الحل لهذا النوع من الأزمات. لمساعدة المطورين الجدد على التنقل في منظومة OpenMRS المتكاملة، وتقصير عملية الإعداد، والسماح لمزيد من الوافدين الجدد بالقدرة على المساهمة بسرعة في تطوير OpenMRS، من الضروري أن تكون لديك وثائق موجزة وواضحة وحديثة. هناك مستندان حاليان للمطوِّرين الجدد: • بدء الاستخدام كمطوّر برامج • دليل المطوِّر رغم أنّ بعض المحتوى أصبح قديمًا والتنسيق بحاجة إلى تحسين. الهدف من هذا المشروع هو تحديث المحتوى وتحسين تنسيق هاتين الوثيقتين لجعلهما أكثر سهولة في الاستخدام.
النطاق
- يمكنك إعادة تنظيم محتوى هذين المستندَين وإعادة تنسيقهما. بالنسبة إلى مستند "الخطوات الأولى كمطوّر برامج": أ. قسّم الخطوات البالغ عددها 17 خطوة في التعليمات إلى أقسام، حيث يحتوي كل قسم على خطوات أقل، بحيث يسهل على المستخدم اتباعها. b. إعادة ترتيب الخطوات؛ يمكن دمج بعض الخطوات. ج- قم بإدراج الروابط إلى صفحات ويكي الأخرى في الجداول، بحيث تكون التعليمات أكثر إيجازًا وقابلية للقراءة.
بالنسبة إلى دليل المطوِّر: أ. يمكن اختصار معلومات خلفية OpenMRS الأساسية في الفصول القليلة الأولى، ويمكن توجيه المستخدمين إلى صفحة OpenMRS.org لمعرفة المزيد من التفاصيل. b. يجب نقل فصل "الإعداد" للأعلى قبل فصل عملية التطوير.
عدِّل المحتوى. بالنسبة إلى مستند "البدء كمستند مطور": أ. إعداد بيئة التحديث لنظامي التشغيل Linux وWindows (تقديم Docker). ب. تحديث تهيئة بيئة تطوير البرامج (IDE) لـ IntelliJ وEclipse c. أدرِج رابطًا يؤدي إلى "دليل المطوِّر" أو "دليل المطوِّر" حيثما ينطبق ذلك. د. تأكَّد من أنّ جميع محتويات الرابط محدَّثة.
بالنسبة إلى دليل المطوِّر: أ. قدِّم تعريفًا حول سير عمل التطوير. ب. التعريف بكيفية تنظيم فرق التطوير، وكيفية عمل أعضاء الفريق معًا، وإضافة روابط إلى اجتماع الفريق، ومناقشات الفريق، ومساعدة المطورين الجدد في العثور على الفرق التي قد يرغبون في الانضمام إليها. ج. أضف Docker في فصل إعداد النظام. د. أضِف المزيد من التفاصيل حول الأنواع المختلفة من الوحدات (وحدة التطبيق المرجعية، ووحدة OWA، ووحدة النظام الأساسي)، وكيفية عملها معًا. هـ. أضف نماذج الأكواد البسيطة لإظهار كيفية إنشاء كل نوع من الوحدات ونشره. و. أضف أمثلة اختبار بسيطة لكل نوع من الوحدات.
تحليل الجمهور
إن الجمهور المستهدف لدليل "الشروع في العمل كمطور" ودليل المطوّر هم مطوِّرون ليس لديهم معرفة كافية بـ OpenMRS أو ليس لديهم معرفة كافية حول هذه الخدمة. يمكن أن يكون هناك نوعان من المطوّرين: النوع الأول من الجمهور هو المطوّرون المبتدئون الذين لديهم خبرة قليلة في تطوير البرامج أو ليس لديهم خبرة في تطوير البرامج. على سبيل المثال، طلاب GSoC الذين يبحثون عن مشروعات حقيقية للتعرف على تطوير البرمجيات مفتوحة المصدر. وبالنسبة إلى هؤلاء المطورين، يجب أن يقدم المستندان تفاصيل ومراجع كافية بحيث يمكنهم البدء في سد الثغرات المعرفية، والبدء في المساهمة في مشروعات OpenMRS في فترة زمنية قصيرة نسبيًا. الأهداف الرئيسية للمطورين المبتدئين هي: 1. فهم المهارات اللازمة للمشاركة في OpenMRS (MySQL، Java Spring. React.js وGit وما إلى ذلك) والعثور على الموارد لتعلم هذه المهارات. 2. انضم إلى منتدى OpenMRS، وتعرّف على أدوات التواصل. 3. إعداد البيئة وبيئة التطوير المتكاملة 4. ثبِّت حزمة OpenMRS SDK. 5. فهم سير عمل التطوير. 6. إنشاء رمز بسيط لإنشاء وحدات جديدة 7. انشر الوحدات التي تم إنشاؤها حديثًا. 8. اختبار الوحدات. 9. استخدم Git لتقديم طلبات السحب. أما النوع الثاني من الجمهور، فهو المطورون من المستوى المتوسط أو كبار المطورين الذين يتطلعون إلى تخصيص OpenMRS لتناسب احتياجات مؤسستهم أو للمساهمة في OpenMRS. وبالنسبة إلى هؤلاء المطورين الأكثر خبرة، يجب أن يقدم المستندان نظرة عامة على OpenMRS وأن يكونا بمثابة دليل لتوجيههم إلى التفاصيل الأكثر تعمقًا حول التكنولوجيات في دليل المطوِّر ومصادر أخرى. تتمثل الأهداف الرئيسية للمطورين ذوي الخبرة في: 1. فهم نموذج البيانات وبنية OpenMRS 2. انضم إلى منتدى OpenMRS، وتعرّف على أدوات التواصل. 3. البحث عن روابط إلى مستودعات رمز OpenMRS 4. اطّلِع على مزيد من المراجع المفصّلة.
خطة المشروع
مرحلة التخطيط: • تحسين الأهداف المحددة في قسم "النطاق" • تحديد المحتوى القديم • إنشاء مخططات للوثيقتين • تقديم المخطط إلى المرشد والخبراء المختصين (SME) • تحديث خطة المشروع
مرحلة تطوير المحتوى • تعلم Docker بجميع خطوات التثبيت وإعداد نموذج تعليمات برمجية/رمز اختباري بسيط • إجراء مقابلة مع الخبراء المختصين لطرح الأسئلة • إعداد المسودة الأولى من المستندين
مراجعة المحتوى ونشره • إجراء تعديل ذاتي على المحتوى • إرسال المسودات المكتملة إلى المراجعين (المرشدين والخبراء المختصين) والمستخدمين للحصول على ملاحظاتهم • مراجعة المسودة • نشر المستندين في صفحة OpenMRS wiki. • كتابة تقرير المشروع
العمل الأولي
لقد أنجزت بعض الأعمال في إعداد بيئة التطوير في نظام Linux وإعداد حزمة OpenMRS SDK. أنا بصدد إعداد بيئة التطوير المتكاملة. سأواصل العمل على إنشاء وحدات بسيطة وكتابة رمز الاختبار.
المراجع والمناقشات
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/188861/14 https://talk.openmrs-course/28502/