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

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

‫موسم التوثيق التقني هو برنامج استدامة يديره مكتب برامج Google المفتوحة المصدر. في ما يلي أهداف موسم التوثيق التقني:

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

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

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

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

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

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

بعد قبول المؤسسات في البرنامج، تقوم بتوظيف كتّاب المحتوى الفني مباشرةً. يستخدم موسم التوثيق التقني 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 مؤسسة من المؤسسات التي سبق لها الاشتراك في البرنامج.

وظّفت المشاريع الـ 31 المقبولة 58 كاتب محتوى فني. أبدى أكثر من 190 كاتب محتوى فني اهتمامهم بالمشاركة في البرنامج من خلال إضافة معلومات الاتصال وروابط إلى ملفات أعمالهم في مستودع موسم التوثيق التقني على 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، التي تتضمّن روابط إلى اقتراحات المشاريع الأصلية ودراسات الحالة الكاملة لكل مؤسسة.

الميزانيات

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

المقاييس

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

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

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

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

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

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

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

العمل مع كتّاب المحتوى الفني

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

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

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

توظيف

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

توظيف

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

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

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

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

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

تم تعديل بعض التوصيات وتكثيفها لتكون أكثر وضوحًا.

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

المشاكل الشائعة في العمل مع كتّاب المحتوى الفني

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

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

استبيانات المتابعة

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

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

كما هو الحال دائمًا، كلما تعلّمنا المزيد عن المستندات في المشاريع المفتوحة المصدر، زادت رغبتنا في التعلّم!

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

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

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