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

"موسم المستندات" هو برنامج مستدام تديره Google Open Source Programs Office. تشمل أهداف "موسم التوثيق التقني" ما يلي:

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

يمكنك الاطّلاع على مزيد من المعلومات عن "موسم المستندات" على الموقع الإلكتروني الخاص بالبرنامج.

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

آلية عمل "موسم التوثيق التقني"

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

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

بعد قبول المؤسسات في البرنامج، يمكنها تعيين الكتاب الفنيين مباشرةً. يستخدم برنامج Season of Docs منصة Open Collective لتمويل المؤسسات، وتدفع المؤسسات للكتاب الفنيين من خلال Open Collective. تكون ميزانيات المشاريع والدفعات شفافة، ويتم تضمين الميزانيات في عروض مشاريع المؤسسات المتاحة على موقع "موسم المستندات" الإلكتروني، وتظهر الدفعات في حساب "موسم المستندات" على 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 كاتبًا تقنيًا اهتمامهم بالمشاركة في البرنامج من خلال إضافة معلومات الاتصال والروابط إلى أعمالهم في مستودع GitHub الخاص بموسم "مستندات Google".

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

  • حظيت جميع المؤسسات بتجربة إيجابية في ما يتعلّق بعملية تقديم الطلبات.
  • حظيت جميع المؤسسات بتجربة إيجابية مع مستندات/محتوى الموقع الإلكتروني للبرنامج.
  • حظيت% 93 من المؤسسات بتجربة إيجابية مع البرنامج.
  • اعتبرت نسبة% 90 من المؤسسات أنّ مشروع إعداد المستندات كان ناجحًا.

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

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

رسم بياني شريطي يعرض المجالات التي تمثّلها المشاريع المقبولة: البيانات: 5 مشاريع، وأدوات التطوير: 4 مشاريع، وتطبيقات المستخدم النهائي: 7 مشاريع، والأجهزة والروبوتات: مشروعان، والبنية الأساسية والسحابة الإلكترونية: 4 مشاريع، ولغات البرمجة والأدوات: 3 مشاريع، والعلوم والطب: 3 مشاريع، والأمان: مشروع واحد، والتواصل الاجتماعي: مشروع واحد، وأدوات الويب والأطر: مشروع واحد

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

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

رسم بياني شريطي يعرض عدد المشاريع التي تستخدم كل ترخيص من تراخيص البرامج مفتوحة المصدر: AGPL-3.0: مشروعان؛ Apache-2.0: 9 مشاريع؛ BSD-3-Clause: 4 مشاريع؛ GPL-3.0: 3 مشاريع؛ LGPL 3.0: 3 مشاريع؛ MIT: 5 مشاريع؛ Mozilla Public license 2.0: مشروعان؛ BSL-1.0 وGPL-2.0 وLGPL-2.1: مشروع واحد لكلّ منهما

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

مشاكل في المستندات

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

رسم بياني شريطي يعرض المشاكل التي أبلغت عنها المؤسسات: عدم توفّر مستندات لحالات استخدام معيّنة لبعض جوانب المشروع: 16 مشروعًا؛ عدم تنظيم المستندات: 11 مشروعًا؛ المستندات قديمة: 7 مشاريع؛ المستندات غير متّسقة: مشروع واحد؛ يجب تحويل المستندات إلى أداة أو منصة أو تنسيق مختلف: 8 مشاريع

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

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

كانت مستندات التعليمات هي نوع المستندات الأكثر ذكرًا في دراسات الحالة لعام 2022.

مخطّط بياني يعرض أنواع المستندات التي تم إنشاؤها:  تعليمات الاستخدام: 12 مشروعًا؛ الأدلة التعليمية: 9 مشاريع؛ المراجع: 8 مشاريع؛ الصفحة المقصودة: 5 مشاريع؛ مستندات واجهة برمجة التطبيقات: 4 مشاريع؛ المخططات البيانية ولقطات الشاشة والرسوم التوضيحية: 4 مشاريع؛ بدء الاستخدام، دليل الأنماط، الدليل: 3 مشاريع لكلٍّ منها؛ الأمثلة، مستندات المفاهيم، أبحاث المستخدمين: مشروعان لكلٍّ منها

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

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

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

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

الميزانيات

كان متوسّط طلب الميزانية 11,679 دولارًا أمريكيًا وكان المتوسط 12,150 دولارًا أمريكيًا. طلبت خمس مؤسسات أكبر منحة متاحة (15 ألف دولار أمريكي) وتلقّتها، وطلبت ثلاث مؤسسات الحد الأدنى (بين 5 آلاف و7 آلاف دولار أمريكي).

المقاييس

مشاريع مُوضَّحة في دراسات الحالة للمقاييس التي كانت تستخدِمها لقياس نجاح مشاريع التوثيق

في ما يلي أهم المقاييس المقترَحة:

رسم بياني شريطي يعرض مقاييس نجاح المستندات: مزيد من المساهمين/طلبات سحب البيانات: 12 مشروعًا، إجمالي النسبة المئوية للمعلومات المستهدَفة التي تغطيها المستندات: 8 مشاريع، عدد أقل من المشاكل/الأسئلة المتعلّقة بالمشروع: 7 مشاريع، عدد أكبر من الزوّار الذين يستخدمون المستندات: 6 مشاريع، تحسين تحسين محركات البحث: 5 مشاريع، زيادة في مستوى الرضا عن المستندات (من خلال الاستطلاع)، زيادة في استخدام المشروع، زيادة في عدد النجوم/عمليات النسخ على GitHub: 3 مشاريع لكلّ منها، إجمالي عدد المستندات التي تم إنشاؤها واختبار المستخدمين النوعي: مشروعان لكلّ منهما

وتشمل المقاييس المقترَحة الأخرى ما يلي:

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

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

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

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

العمل مع الكتاب الفنيين

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

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

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

توظيف

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

توظيف

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

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

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

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

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

تم تعديل بعض الاقتراحات وتكثيفها لزيادة الوضوح.

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

رسم بياني شريطي يعرض مصدر المرشحين لكاتب فني: تقدموا بطلبات مباشرةً إلى البرنامج: 18؛ مستخدمو GitHub في SoD أو مشاركون سابقون في SoD: 6؛ أعضاء في المنتدى: 5؛ غير محدّد: 3؛ تقدموا بطلبات عبر موقع التوظيف: 1

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

رسم بياني شريطي يعرض مشاكل الكتاب التقنيين: انسحاب الكتاب التقنيين من 4 مشاريع، ومشاكل في الاتصالات، وإعداد الكتاب التقنيين، ومهارات الكتاب التقنيين، ونقص المعرفة بالمجالات، ومصادرة الأجهزة، والتضارب مع العمل الجاري الآخر: مشروع واحد لكلّ منهما

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

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

الاستطلاعات اللاحقة

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

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

كالعادة، كلما زادت معرفتنا بالمستندات في البرامج مفتوحة المصدر، زادت رغبتنا في التعلم.

في المواسم المستقبلية، نأمل تحقيق ما يلي:

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

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