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

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

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

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

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

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

التغييرات في البرنامج لعام 2021

في عامَي 2019 و2020، قدّمت المؤسسات والكتاب الفنيون طلبات منفصلة للانضمام إلى برنامج "موسم المستندات"، وقام مشرِفو البرنامج بتزويج الكتاب الفنيين مع المؤسسات. ووفّرت المؤسسات مرشدين للعمل مع الكتاب التقنيين الذين تلقّوا مكافأة مقابل عملهم استنادًا إلى موقعهم الجغرافي. وقد قيّم البرنامج مدى رضا الكُتاب الفنيين والمرشدين ومشرفي المؤسسات عن مشاركتهم في البرنامج، ولكنّه لم يقِّم نتائج إعداد المستندات.

في عام 2021، أجرى فريق "موسم المستندات" تغييرات كبيرة على البرنامج، مع التركيز على قياس نتائج التوثيق والسماح بمزيد من المرونة للمؤسسات والكتاب الفنيين.

  • المؤسسات التي قدّمت عروض مشاريع، بما في ذلك ميزانية ومقاييس مقترَحة
  • لم يعُد الكتاب الفنيون يتقدمون بطلبات من خلال Google لمطابقتهم مع المؤسسات، بل يتقدمون بطلبات مباشرةً إلى المؤسسات المقبولة.
  • تلقّت المؤسسات المقبولة منحًا من خلال Open Collective، واستخدمتها لدفع رواتب الكتاب التقنيين.
  • حدّدت المؤسسات تعويضات الكتاب التقنيين.
  • أرسلت المؤسسات تقييمات نهائية ودراسات حالة وأجابت عن استطلاعات المتابعة.

النتائج العامة لعام 2021

المؤسسات

  • أدّت التغييرات في برنامج 2021 إلى انخفاض عدد المؤسسات التي تقدم طلبات الانضمام (شهدنا انخفاضًا في عدد المؤسسات التي تقدم طلبات الانضمام بنسبة% 30 في عام 2021 مقارنةً بعام 2020)، ولكن كان مستوى رضا مشرفي المؤسسات في عام 2021 أعلى قليلاً عن مستوى رضا مشرفي المؤسسات في عام 2020 (%93 مقارنةً بـ %91).

المشاكل وأنواع المستندات والمقاييس

  • ركّزت معظم المشاريع على إنشاء مستندات لتخفيف عبء المشرف (من خلال تقليل المشاكل/الأسئلة) و/أو زيادة المشاركة في المشروع (إما من خلال مستخدمي المشروع أو المساهمين).
    • أنشأت% 50 من المؤسسات المقبولة محتوى تعليميًا أو إرشاديًا.
    • اعتبر أكثر من% 50 من المؤسسات المقبولة أنّ مستنداتها الحالية غير كافية أو غير منظمة أو قديمة.
  • أرادت المشاريع بشكل عام قياس مدى فعالية مستنداتها من خلال التفاعلات، لا سيما تقليل المشاكل التي يتم طرحها وزيادة عدد الزوّار للمستندات والمشاركة في المشاريع.
  • اعتبارًا من تشرين الثاني (نوفمبر) 2022، استجاب 25 مشروعًا من أصل 30 مشروعًا:
    • 18 مشروعًا أفادت أنّها حقّقت المقاييس الأصلية
    • استيفاء 5 مشاريع للمقاييس المعدَّلة
    • أشارت مشاريعان إلى أنّه لا يزال من المبكر جدًا تحديد ذلك.

المشاركة في البرنامج

  • كان تعيين الكتّاب التقنيين وتوظيفهم ودفع رواتبهم هو الجزء الأكثر صعوبة في البرنامج بالنسبة إلى مشرفي المؤسسات.
  • اعتبارًا من تشرين الثاني (نوفمبر) 2022، استجابت 24 مؤسسة من أصل 30 مؤسسة:
    • لا تزال 18 مؤسسة تعمل مع الكتاب الفنيين في "موسم المستندات" (إمّا كمساهمين مستمرين أو كمرجع للإجابة عن الأسئلة).
      • 4 مؤسسات كانت تعمل مع الكتاب الفنيين في "موسم كتابة المستندات" في دور مدفوع

أبرز الأحداث في 2021

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

بيانات الملخّص لعام 2021

في عام 2021، قدّمت 82 مؤسسة طلبًا للانضمام إلى البرنامج وتم قبول 30 مؤسسة تعمل في مجال البرامج المفتوحة المصدر. (اطّلِع على دليل إنشاء طلبك لمعرفة معايير الاختيار). يمكنك الاطّلاع على القائمة الكاملة للمؤسسات المشاركة على موقع "موسم المستندات" الإلكتروني. أرسلت جميع المؤسسات الثلاثين المقبولة تقرير دراسة الحالة النهائي لإكمال مشاركتها في برنامج 2021.

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

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

  • مشاريع لغوية كبيرة، مثل Julia وPerl وR
  • المشاريع في مجال التعليم والمناخ والتكنولوجيا المالية والرعاية الصحية وخدمات المكتبات وتعلُّم الآلة والتحليل الطيفي الشامل والعقود العامة والروبوتات
  • المشاريع التي تركّز على المطوّرين، بما في ذلك أدوات هندسة الفوضى وأدوات البحث عن الأخطاء وأدوات تطوير برامج الدردشة الآلية وعمليات تحليل تركيب البرامج وأدوات مراقبة الأداء وأدوات البرمجة المرئية
  • مشاريع إعداد المستندات لأدوات إعداد المستندات، مثل Redocly وMetanorma

كانت مشاريع منظومة Python المتكاملة هي الفئة الفرعية الأكبر. ضمّت مجموعة 2021 ArviZ وNumPy وMicroPython وPyMC3 وPyTorch-Ignite وSymPy.

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

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

رسم بياني شريطي يعرض عدد المشاريع التي تستخدم كل ترخيص من تراخيص البرامج مفتوحة المصدر: Apache 2.0: عشرة برامج، و3-clause BSD: خمسة برامج، وMIT: خمسة برامج، وGPL 2.0: 4 برامج، وLGPL 2.1: 4 برامج، وMozilla Public license 2.0: 3 برامج، وArtistic وBoost و2-clause BSD: برنامج واحد لكل منها

إنّ مشاكل المستندات التي حدّدتها المؤسسات في عام 2021 هي مشاكل شائعة جدًا في كلّ من المشاريع مفتوحة المصدر والمستندات الفنية بشكل عام.

تشمل أهمّ المشاكل التي كانت المؤسسات تأمل في حلّها في برنامج 2021 ما يلي:

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

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

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

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

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

تشمل أنواع المستندات الأخرى المذكورة في دراسات الحالة مسار المستندات بتنسيق رمز، والمخطّط البياني، والمسرد، ودليل الأنماط، والأسئلة الشائعة، والتعريب، وCodelab، ونموذج المحتوى، والوحدات، ومستندات المفاهيم، ورسائل الخطأ، وأبحاث المستخدمين، وملف Readme، وقاعدة المعلومات.

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

تمّت الإشارة إلى العديد من المشاريع تحديدًا باستخدام إطار عمل Diátaxis كدليل لتخطيط أنواع مستنداتها.

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

الميزانيات

في عام 2021، كان متوسّط طلبات الميزانية 10,200 دولار أمريكي وكان المتوسط 10,000 دولار أمريكي. طلبت ثلاث مؤسسات فقط الحد الأقصى من المنحة الممكنة (15 ألف دولار أمريكي) وتلقّتها، وطلبت ثلاث مؤسسات أخرى الحد الأدنى من المنحة الممكنة (5 آلاف دولار أمريكي).

المقاييس

وضّحت دراسات الحالة المقاييس التي كانت تستخدمها لقياس مدى نجاح مشاريع التوثيق.

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

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

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

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

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

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

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

في عام 2021، قدّم الكتاب الفنيون طلبات للانضمام إلى المشاريع مباشرةً، وحدّدت المشاريع ميزانية تعويض الكتاب الفنيين، وتم إجراء الدفعات من خلال صندوق Open Collective في "موسم المستندات".

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

اقتراحات التوظيف

تمّت دعوة المشاريع لتقديم اقتراحات لمشاريع أخرى مهتمة بالمشاركة في "موسم المستندات". في ما يلي أهم اقتراحات التوظيف:

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

رسم بياني شريطي يعرض مصدر المرشحين للكتابة الفنية: تقدّم 7 مرشّحين للبرنامج مباشرةً، وتقدّم 4 مرشّحين من خلال GitHub أو من خلال مشاركتهم السابقة في برنامج "معسكر كتابة الرموز البرمجية في الصيف"، وتقدّم 3 مرشّحين من خلال Slack أو من خلال المنتدى في "مستندات Google"، وتقدّم 2 مرشّحَين من خلال موقع إلكتروني للوظائف (Upwork أو LinkedIn) أو من خلال خريجي برنامج "معسكر كتابة الرموز البرمجية في الصيف" أو "Code-In"

(ملاحظة: لم يتم الإشارة في دراسات الحالة إلى جميع المشاريع التي تم فيها تعيين المرشحين لكاتبي المحتوى الفني).

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

رسم بياني شريطي يعرض مشاكل الكتاب التقنيين: إيقاف الكتاب التقنيين: 8 مشاريع، مشاكل في الاتصالات: 6 مشاريع، إعداد الكتاب التقنيين: 4 مشاريع، تعيين الكتاب التقنيين، التوظيف أو الدفع، إعداد أدوات المشروع: 3 مشاريع لكل منها

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

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

تأخّرت دفعات بعض المشاريع للكتاب الفنيين بسبب مشاكل مصرفية في Open Collective أو بسبب فرض قيود على الدفع في بلدان الكتاب الأصلية.

لم تكن مستندات البرنامج حول رسوم Open Collective واضحة: كانت Google تغطّي رسوم المعاملات في Open Collective للتحويل الأولي للأموال إلى المشاريع، ولكن ليس رسوم المعاملات التي تفرضها بعض قنوات الدفع الأخرى (مثل رسوم تحويل العملة). وسنعمل على توضيح ذلك بشكل أفضل في مستندات البرامج المستقبلية.

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

كجزء من برنامج "موسم المستندات"، طُلب من المشاريع المشاركة في استطلاعات المتابعة. تم إرسال ثلاثة استطلاعات في أيار (مايو) وأغسطس (آب) وتشرين الثاني (نوفمبر) 2022.

رسم بياني شريطي يعرض عدد الردود على استطلاع المتابعة: استطلاع شهر أيار (مايو): 13 ردًا، واستطلاع شهر آب (أغسطس): 21 ردًا، واستطلاع شهر تشرين الثاني (نوفمبر): 12 ردًا

طلب استطلاع المتابعة من المشاريع تأكيد أنّ روابط الاقتراح ودراسة الحالة لا تزال نشطة. تضمن الاستطلاع أيضًا أسئلة حول نجاح مشاريعهم (على النحو الذي تحدّده المقاييس التي حدّدوها في دراسة الحالة) واستمرار مشاركة الكتاب الفنيين للمشاريع وتعويضهم:

  1. هل ما زلت تعمل مع الكاتب الفني الذي تم تعيينه لك في برنامج "موسم المستندات"؟

رسم بياني شريطي يعرض المشاركة المستمرة من قِبل الكتاب الفنيين، حسب الاستطلاع: في أيار (مايو)، شارك كتاب فنيون في 6 مشاريع أو كانوا يجيبون عن الأسئلة، ولم يشارك أي كاتب فني في مشروع واحد. في شهر آب (أغسطس)، شارك 11 مشروعًا في كتابة المحتوى الفني بشكلٍ مستمر، ولم يشارك 7 مشاريع في كتابة المحتوى الفني بشكلٍ مستمر، وشارك 3 مشاريع في كتابة المحتوى الفني للإجابة عن الأسئلة. في تشرين الثاني (نوفمبر)، أبلغت 5 مشاريع عن مشاركة مستمرة من جانب الكتاب الفنيين، وأبلغت 3 مشاريع عن عدم مشاركة الكتاب الفنيين بشكل مستمر، وأبلغت 4 مشاريع عن إجابة الكتاب الفنيين عن الأسئلة.

  1. إذا كان الكاتب التقني لا يزال يعمل على مشروعك، هل يتم تعويضه بأي شكل من الأشكال؟

رسم بياني شريطي يعرض عدد المشاريع التي تُبلغ عن تعويضات المشاريع للكاتبِين الفنيِين في كل استطلاع في شهر أيار (مايو)، أبلغت 5 مشاريع عن أنّها تدفع لكاتبيها الفنيين مقابل عملهم الجاري، بينما أبلغت 4 مشاريع عن أنّها لا تدفع لكاتبيها الفنيين. في آب (أغسطس)، أبلغت 4 مشاريع عن دفع رسوم للكاتب الفني، وأبلغت 7 مشاريع عن عدم دفع رسوم للكاتب الفني. في تشرين الثاني (نوفمبر)، أبلغ مشروعان عن دفع رسوم للكاتب الفني، وأبلغ 5 مشاريع عن عدم دفع رسوم للكاتب الفني.

  1. في هذه المرحلة، هل تعتقد أنّ مشروع التوثيق ناجح؟

رسم بياني شريطي يعرض عدد المشاريع التي تسجّل نجاحًا وفقًا للمقاييس في كل استطلاع في أيار (مايو)، أبلغت 6 مشاريع عن استيفاء مقاييس الأداء، بينما أشارت 6 مشاريع إلى أنّه من السابق لأوانه تحديد ذلك، واستوفى مشروعان المقاييس المعدَّلة. في آب (أغسطس)، أبلغ 16 مشروعًا عن استيفاء المقاييس، وأبلغ 3 مشاريع عن استيفاء المقاييس المعدَّلة، وأبلغ مشروعان عن أنّه من السابق لأوانه تحديد ذلك. في تشرين الثاني (نوفمبر)، أبلغت 9 مشاريع عن استيفاء المقاييس، وأبلغت 3 مشاريع عن استيفاء المقاييس المعدَّلة، ولم تُبلغ أي مشاريع عن أنّه ما زال من السابق لأوانه تحديد ذلك.

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

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

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

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