تقرير دراسة حالة لعام 2022

المرحلة الحالية:
تطوير المستندات: يمكنك الاطّلاع على المخطط الزمني.

ملاحظة: يلخص هذا التقرير البيانات من تطبيقات البرنامج الأصلية ومن دراسات الحالة النهائية للمؤسسات. تتوفر روابط إلى دراسات الحالة الكاملة في صفحة نتائج "موسم مستندات Google" لعام 2022.

Season of Docs هو برنامج استدامة يديره مكتب البرامج المفتوحة المصدر من Google. تتمثل أهداف "موسم المستندات" في:

• تقديم الدعم للمشروعات مفتوحة المصدر لحل مشكلات المشروع من خلال التوثيق
• منح المؤلفين التقنيين فرص اكتساب خبرة في البرامج المفتوحة المصدر
• زيادة الوعي بالبرامج المفتوحة المصدر والتوثيق والكتابة الفنية
• جمع ومشاركة معلومات حول المقاييس الفعالة في وثائق البرامج المفتوحة المصدر

يتوفر مزيد من المعلومات حول "موسم المستندات" على الموقع الإلكتروني للبرنامج.

نظرة عامة على برنامج عام 2022

طريقة عمل "موسم المستندات"

في "موسم المستندات"، تتقدم المؤسسات من خلال إرسال اقتراح مشروع. يتضمن مقترح المشروع ما يلي:

• معلومات حول المؤسسة
• وصف المشكلة التي يواجهها المشروع
• كيف سيستخدم المشروع الوثائق للمساعدة في حل مشكلته
• كيف سيقيس المشروع فعالية وثائقه (المقاييس)
• جدول زمني للعمل
• ميزانية المشروع
• أي معلومات إضافية، مثل خبرة المؤسسة في البرامج المماثلة، أو أي معلومات أخرى من شأنها أن تساعد مشرفي "موسم المستندات" على فهم مشروعهم ومشكلتهم

بعد قبولها في البرنامج، تعمل المؤسسات على توظيف كتّابها التقنيين وتوظيفهم مباشرةً. يستخدم موسم المستندات Open Collective لتمويل المؤسسات، وتدفع المؤسسات رسومًا للكاتبين التقنيين من خلال Open Collective. تتسم ميزانيات المشروعات ودفعاتها بالشفافية، ويتم تضمين الميزانيات في مقترحات مشاريع المؤسسة المتاحة على موقع Season of Docs، والمدفوعات مرئية في حساب Season of Docs Open Collective

يتم اعتبار المؤسسات قد أكملت البرنامج بنجاح عندما ترسل تقرير دراسة الحالة. يُطلب من المؤسسات أيضًا إكمال تقييمات شهرية أثناء البرنامج وثلاثة استبيانات متابعة ربع سنوية خلال العام التالي لإكمال البرنامج.

أبرز لحظات 2022

"بعد إصدار المستند الجديد، تضاعف عدد الزيارات اليومية إلى Casbin وCasdoor تقريبًا، وانخفضت معدلات الارتداد بحوالي 30٪". — Casbin

"أحد النتائج المبهجة لهذا المشروع هو مشاهدة [كتابنا التقنيين] وهم يتحوّلون إلى أدوار قيادية في مجتمعنا. ويتولى المساهمون الآن قيادة فرق العمل واجتماعات المنتدى، كما يساهمون في تصميم مشاريعنا وصيانتها". —moja-global

"لقد ساعدتنا [GSoD] على توظيف كاتبَين تقنيَّين موهوبين، وهو أمر صعب للغاية في إطار الإعداد المنتظم، ويستمران في كونهما مساهمَين نشطَين في أنظمة التشغيل في OpenMined، ولديهما خبرة عمل رائعة معهم". —OpenMined

"كذلك، الدليل الجديد أسهل بكثير على المبتدئين في قياس الطيف الكتلي الحوسبي. لتوضيح هذه النقطة، تقدم منحة CZI أيضًا رواتب للأشخاص المحرومين تاريخيًا، واستخدم بعض الحاصلين على الجائزة دليل OpenMS الجديد لبدء فترة تدريب مدتها ستة أسابيع، وقدّموا مراجعات إيجابية للدليل الجديد." —OpenMS

بيانات ملخّص 2022

في عام 2022، قبِل برنامج "موسم المستندات" 31 مشروعًا من 67 طلبًا وأكمل البرنامج بنجاح 30 مشروعًا. من بين 31 مؤسسة مقبولة، تم تقديم 17 مؤسسة بشكل متكرر.

وتم تعيين 58 كاتبًا تقنيًا ضمن المشروعات البالغ عددها 31 مشروعًا. أشار أكثر من 190 كاتبًا تقنيًا عن اهتمامهم بالمشاركة في البرنامج من خلال إضافة معلومات الاتصال الخاصة بهم والروابط إلى محافظهم في مستودع Season of Docs GitHub.

بالنسبة إلى برنامج 2022:

• كانت لدى 100٪ من المؤسسات تجربة إيجابية مع عملية تقديم الطلبات
• كانت لدى 100٪ من المؤسسات تجربة إيجابية مع وثائق/محتوى موقع البرنامج
• كانت لدى 93٪ من المؤسسات تجربة إيجابية مع البرنامج
• شعرت 90٪ من المؤسسات أن مشروع التوثيق الخاص بها ناجحًا

لمحة عن المؤسسات

مثّلت المؤسسات المشارِكة في "موسم المستندات" 2022 مجموعة متنوعة من المشاريع المفتوحة المصدر. وشملت المجموعة النموذجية لعام 2022 ما يلي:

• أدوات التطوير، مثل AsyncAPI وSpyderIDE
• لغات البرمجة وأطر العمل، مثل Julia وLFortran وR وp5.js
• المشاريع العلمية، مثل CERN-HSF وSymPy
• التطبيقات الخاصة بالمستخدمين، مثل Mautic وOpen Food Facts وTalawa وUshahidi
• مشاريع الأجهزة والروبوتات، مثل ExpressLRS وOpen-RMF
• مشاريع البيانات، مثل GeomScale وGeomStats وOpenMined وWeaviate
• مشاريع السحابة الإلكترونية والبنية الأساسية، مثل cert-manager وNimbleEdge وCilium

لم نجمع أي بيانات وصفية حول المشاريع (مثل تاريخ التأسيس أو التوزيع الجغرافي للمساهمين أو عدد المساهمين أو حجم قاعدة المستخدمين).

لقد طلبنا من المشروعات الإشارة إلى ترخيص البرامج المفتوحة المصدر الذي استخدموه.

حول مشروعات التوثيق

مشكلات التوثيق

تضمّنت أهم المشاكل التي كانت المؤسسات تأمل في حلّها من خلال التوثيق في برنامج عام 2022 ما يلي:

يُرجى العلم أنّه يمكن للمؤسسات الإبلاغ عن مشاكل متعددة في المستندات. لمزيد من التفاصيل، يمكنك الاطّلاع على صفحة نتائج موسم 2022 التي تتضمن روابط إلى اقتراحات المشروع الأصلية ودراسات الحالة الكاملة لكل مؤسسة.

أنواع المستندات التي يتم إنشاؤها

كانت الوثائق الإرشادية أكثر أنواع الوثائق شيوعًا في دراسات الحالة لعام 2022.

تضمنت أنواع الوثائق الأخرى المذكورة في دراسات الحالة ما يلي:

• التشغيل السريع
• مسرد المصطلحات
• الأسئلة الشائعة
• قاعدة المعلومات
• المكوّنات
• محتوى مدونات/وسائل التواصل الاجتماعي
• دليل الصيانة

بعض هذه الفئات غير واضحة ويمكن أن يحتوي مشروع الوثائق الواحد على أنواع أو ميزات متعددة من الوثائق.

لمزيد من التفاصيل، يمكنك الاطّلاع على صفحة نتائج موسم 2022 التي تتضمن روابط إلى اقتراحات المشروع الأصلية ودراسات الحالة الكاملة لكل مؤسسة.

الميزانيات

وكان متوسط طلب الميزانية 11679 دولارًا أمريكيًا (أو ما يعادله بالعملة المحلية)، وكان المتوسط 12150 دولارًا أمريكيًا. طلبت خمس مؤسسات وحصلت على أعلى منحة متاحة (15 ألف دولار أمريكي) وطلبت ثلاث مؤسسات أقلها (بين 5 آلاف دولار و7 آلاف دولار).

المقاييس

حددت المشروعات في دراسات الحالة الخاصة بهم المقاييس التي كانوا يستخدمونها لقياس نجاح مشروعات التوثيق الخاصة بهم.

كانت أهم المقاييس المقترحة هي:

تضمنت المقاييس المقترحة الأخرى ما يلي:

• المزيد من طلبات سحب المستندات/المساهمات
• المزيد من الملاحظات المباشرة على صفحات التوثيق
• الوقت المستغرَق في الصفحة
• المشاكل المطروحة (كخادم وكيل للاستخدام)
• المشاركون في المنتديات
• عدد الشركاء/المتطوعين/عمليات الدمج
• انخفاض معدل الارتداد
• زيادة الوعي في المجتمع

بسبب الفترة القصيرة بين إنهاء مشاريع الكتابة التقنية وإرسال دراسات الحالة، لم تتمكّن معظم المجموعة النموذجية لعام 2022 من جمع بيانات كافية وقت إرسال دراسات الحالة لتحديد ما إذا تم استيفاء المقاييس الأولية أم لا.

عندما نتلقّى إجابات على استطلاعات المتابعة في 2023، سنعدّل هذا التقرير لإضافة معلومات حول المشاريع التي حقّقت مقاييسها أو عدّلت مقاييسها.

لمزيد من التفاصيل، يمكنك الاطّلاع على صفحة نتائج موسم 2022 التي تتضمن روابط إلى اقتراحات المشروع الأصلية ودراسات الحالة الكاملة لكل مؤسسة.

العمل مع الكُتّاب التقنيين

في برنامج Season of Docs، يُتوقع من المشروعات توظيف الكُتّاب التقنيين وإجراء مقابلات معهم وتوظيفهم ودفع أجورهم مباشرةً. يمكن للكتاب الفنيين إضافة أنفسهم إلى الدليل الذي يتم الاحتفاظ به من خلال ميزة Season of Docs في مستودع GitHub، ولكن لا يقوم موظفو "موسم المستندات" بالتدقيق في الكُتّاب الفنيين أو اقتراحهم.

أفضل الممارسات لتوظيف الكتّاب التقنيين للمشروعات مفتوحة المصدر

طُلب من المشروعات مشاركة أفضل ممارساتها للتوظيف والتوظيف والعمل مع الكتاب الفني. أهم الاقتراحات كانت:

توظيف

• مقابلة عدد أقل من المرشحين، واستخدام جلسة تدريبية مباشرة بدلاً من مراجعة السير الذاتية فقط
• قيمة مهارات التواصل المكتوبة والشفهية على مستوى الإجادة في لغة مشروعك أو أدواتك
• اطرح أسئلة مباشرة حول كيفية اكتساب الكاتب التقني لأي معرفة بالمجال ضرورية للعمل على مشروعك
• من المرجح أن يظل الشخص الذي يتحمس لمهمة مشروعك ويشارك القيم الأساسية مفتوحة المصدر متحمسًا طوال المشروع
• كن منفتحًا على المتقدمين من جميع أنحاء العالم، لأن تنوع وجهات النظر والخلفيات سيساعد مشروعك - ولكن ضع في اعتبارك أن وجود كتّاب ومرشدين في عدد كبير جدًا من المناطق الزمنية المتعارضة قد يتطلب الكثير من الجهد الإضافي للحفاظ على تواصل جيد

عدد الموظفين المطلوبين

• استخدام عقد يوضح بوضوح المُخرَجات النهائية وجداول الدفع والالتزامات الزمنية المحددة
• إذا كان مشروعك يحتوي على الكثير من الأشياء المجهولة، فقم بتضمين معلم رئيسي للاكتشاف أو البحث بشكل منفصل عن إنشاء الوثائق

التنسيق والتواصل

• الاحتفاظ بقرارات تسجيل سجل الاجتماعات لتسهيل فهم كل من يعمل في المشروع على السياق والخطوات التالية
• كن واضحًا بشأن التواصل المتوقع وعدد المرات، سواء كانت مكالمات أسبوعية أو رسائل إلكترونية يومية أو تحديثات الحالة في قناة دردشة.
• التحلي بالاستجابة وتقديم ملاحظات واضحة تتضمن "لماذا" وليس "ماذا" فقط
• يمكنك التواصل بين الكتّاب التقنيين والمنتدى الأوسع لتوفير سياق لهم وإشراكهم في أعمالهم.

العمليات والأدوات

• إنشاء عملية توثيق تستمر إلى ما بعد برنامج "موسم المستندات"، ويمكن للمنتدى بأكمله المساهمة فيها
• ستستغرق مراجعة الوثائق وقتًا طويلاً على الأقل، كما تستغرق مراجعة الرموز، لذلك تأكد من تخصيص وقت كافٍ لها.

تم تعديل بعض الاقتراحات وتخصيصها لمزيد من التوضيح.

كما في برنامج عام 2021، تقدّم معظم الكتّاب الفنيين في Season of Docs لعام 2022 طلبًا مباشرةً إلى المؤسسات التي عملوا معها.

المشاكل الشائعة في العمل مع الكُتّاب التقنيين

وأبلغ عدد أقل من المشاريع عن مشاكل في العمل مع الكُتّاب الفنيين لها في برنامج 2022. كان عدم القدرة على إكمال البرنامج هو أكبر مشكلة بسبب مرض أو الحصول على وظيفة بدوام كامل أو عدم القدرة على الوفاء بالوقت المطلوب.

وذكر أحد المشاريع أنّ مشروع التوثيق كان يعتمد على العمل الذي يتم تنفيذه كجزء من برنامج Google Summer of Code، وأنّه كان من الصعب إدارة هذه التبعيات. واجه مشروع آخر صعوبات عندما أزالت وزارة الدفاع الأجهزة التي كان كاتبها التقني يحتاج إلى توثيقها في بلده وتعذّر استيرادها.

استطلاعات المتابعة

سيتم إرسال ثلاثة استطلاعات للمتابعة إلى المشاركين في عام 2022 في أيار (مايو) وآب (أغسطس) وتشرين الثاني (نوفمبر) 2023. سنضيف إلى هذا القسم النتائج فور تلقّيها.

الأسئلة المستقبلية

كالعادة، كلما تعلمنا المزيد عن التوثيق في البرامج المفتوحة المصدر، كلما أردنا تعلم المزيد!

في المواسم القادمة، نأمل أن نحقّق ما يلي:

• اجمع المزيد من البيانات الوصفية للمشروع للبحث عن الارتباطات بين عمر المشروع أو حجم المجتمع أو اللغة واحتياجات التوثيق
• تحليل مشروعات التوثيق لمعرفة ما إذا كان يمكن تعميمها في قوالب قابلة للمشاركة
• وضع نموذج تقييم لإجراء مقابلات مع الكتاب الفنيين في المشروعات مفتوحة المصدر

وبالرغم من وجود العديد من الأسئلة التي نود التحقيق فيها، فإننا نرغب أيضًا في احترام وقت مديري المشروعات مفتوحة المصدر والمشرفين عليها الذين يشاركون في موسم المستندات. الأولوية القصوى للبرنامج هي دعم المشروعات في حل مشكلاتها باستخدام التوثيق.