المرحلة الحالية:
انتهى برنامج Season of Docs لعام 2021 في 14 كانون الأول (ديسمبر) 2021. اطّلِع على
المخطط الزمني.
لمحة عن موسم المستندات
Season of Docs هو برنامج للاستدامة يديره مكتب البرامج المفتوحة المصدر من Google. تهدف ميزة Season of Docs إلى:
- تقديم الدعم لمشروعات البرامج المفتوحة المصدر لحل مشاكل المشروع في التوثيق
- منح المؤلفين التقنيين فرص اكتساب خبرة في البرامج المفتوحة المصدر
- زيادة الوعي بالبرامج المفتوحة المصدر والتوثيق والكتابة الفنية
- جمع معلومات حول المقاييس الفعالة ومشاركتها في وثائق البرامج المفتوحة المصدر
يتوفر المزيد من المعلومات حول Season of Docs على الموقع الإلكتروني للبرنامج.
نظرة عامة على البرنامج لعام 2021
التغييرات في البرنامج لعام 2021
في عامَي 2019 و2020، قدّمت كل من المؤسسات والكتّاب التقنيين طلبًا إلى برنامج Season of Docs بشكل منفصل، وأجرت إدارة برنامج Season of Docs بين الكتّاب التقنيين والكتّاب التقنيين. قدمت المؤسسات مرشدين للعمل مع الكتّاب الفنيين، الذين حصلوا على راتب مقابل عملهم بناءً على موقعهم. يقيس البرنامج ما إذا كان الكتاب الفني والمرشدين ومشرفي المؤسسات راضين عن مشاركتهم في البرنامج، لكنه لم يقيس نتائج التوثيق.
في عام 2021، أجرى فريق Season of Docs تغييرات كبيرة على البرنامج، وتم تحويل التركيز نحو قياس نتائج التوثيق وتوفير المزيد من المرونة للمؤسسات والكتّاب التقنيين.
- تقدمت المؤسسات مع مقترحات مشروعات، بما في ذلك الميزانية والمقاييس المقترحة
- لم يعُد المؤلّفون التقنيون يتقدّمون بطلب من خلال Google لمطابقتها مع المؤسسات، ولكن تم تقديم طلباتهم مباشرةً إلى المؤسسات المقبولة.
- تلقّت المؤسسات المقبولة مِنحًا عبر Open Collective، والتي اعتادت أن تدفع رسومًا للكتّاب التقنيين.
- تم تحديد تعويضات الكتاب الفنيين من قبل المؤسسات
- أرسلت المؤسسات تقييمات نهائية ودراسات حالة وأجابت عن استبيانات متابعة.
النتائج العامة لعام 2021
المؤسسات
- أدّت التغييرات التي طرأت على برنامج 2021 إلى انخفاض عدد المؤسسات التي تتقدّم بطلب الانضمام (لاحظنا انخفاضًا بنسبة% 30 في عدد المؤسسات التي تتقدّم بطلب الانضمام في عام 2021 مقارنةً بعام 2020)، لكن مشرفي المؤسسات في عام 2021 كانوا أكثر رضا عن البرنامج في العام 2020 (93% مقابل 91%).
المشكلات وأنواع المستندات والمقاييس
- ركزت معظم المشروعات على إنشاء الوثائق لتقليل عبء الصيانة (من خلال تقليل المشكلات/الأسئلة) و/أو زيادة المشاركة في المشروع (إما من قبل المستخدمين أو المساهمين في المشروع).
- أنشأت 50% من المؤسسات المقبولة محتوى تعليميًا أو إرشاديًا.
- اعتبر أكثر من 50٪ من المؤسسات المقبولة أن وثائقها الحالية تفتقد أو غير منظمة أو قديمة.
- أرادت المشروعات بشكل عام قياس فعالية وثائقها من خلال التفاعلات، وخاصة عدد أقل من المشكلات المثارة وزيادة عدد زوار المستندات والمشاركة في المشروعات.
- اعتبارًا من تشرين الثاني (نوفمبر) 2022، استجاب 25 من أصل 30 مشروعًا على النحو التالي:
- قال 18 مشروعًا أنها استوفت المقاييس الأصلية
- استوفت 5 مشروعات المقاييس المنقحة
- قال مشروعان أنه ما زال من السابق لأوانه إخباره
المشاركة في البرنامج
- كان تعيين الموظفين التقنيين وتوظيفهم ودفع أقساطهم هو الجزء الأكثر صعوبة في البرنامج بالنسبة إلى مسؤولي إدارة المؤسسات.
- اعتبارًا من تشرين الثاني (نوفمبر) 2022، واستجابت 24 من أصل 30 مؤسسة على النحو التالي:
- لا تزال 18 مؤسسة تعمل مع المؤلفين التقنيين في Season of Docs (إما كمساهمين مستمرين أو كمرجع للإجابة عن الأسئلة)
- كانت 4 مؤسسات تعمل مع كتّابها الفنيين في Season of Docs الذين يؤدون دورًا مدفوعًا
- لا تزال 18 مؤسسة تعمل مع المؤلفين التقنيين في Season of Docs (إما كمساهمين مستمرين أو كمرجع للإجابة عن الأسئلة)
أبرز لحظات 2021
- أشارت عدة مشاريع إلى أن كاتبها الفني كان يعتزم مواصلة العمل في مشروعها بعد نهاية برنامج Season of Docs
- طلب العديد من الكتّاب الفنيين المؤهلين في Metanorma، ووجدوا صناديق مماثلة بهدف توظيف كاتب إضافي للعمل إلى جانب الكتاب المدعوم من "مستندات Google" خلال البرنامج
- وجدت شركة Moja Global أن المجتمع كان مهتمًا جدًا بشأن التوثيق وأنشأت مجموعة عمل جديدة للوثائق للسماح لمزيد من المساهمين بالمشاركة في وثائق المشروع
بيانات ملخّص 2021
في عام 2021، تم قبول 82 مؤسسة و30 مؤسسة مفتوحة المصدر للانضمام إلى البرنامج. (راجع دليل إنشاء طلبك للتعرّف على معايير الاختيار.) يمكن العثور على القائمة الكاملة بالمؤسسات المشارِكة على موقع Season of Docs الإلكتروني. أرسلت جميع المؤسسات الثلاثين المقبولة تقريرها النهائي عن دراسة الحالة لإكمال مشاركتها في برنامج 2021.
لمحة عن المؤسسات
مثّلت المؤسسات المشارِكة في Season of Docs 2021 مجموعة متنوعة من المشاريع المفتوحة المصدر. تضمنت المجموعة النموذجية لعام 2021 ما يلي:
- المشاريع اللغوية الكبيرة، مثل Julia وPerl وR
- المشروعات في التعليم والمناخ والتكنولوجيا المالية والرعاية الصحية وخدمات المكتبات والتعلم الآلي والقياس الكتلي والعقود العامة والروبوتات
- المشاريع التي يركز عليها المطوّرون، بما في ذلك أدوات هندسة الفوضى والزغب وحزم تطوير البرامج (SDK) لبرامج الدردشة المبرمَجة ومسارات تحليل تكوين البرامج وأدوات مراقبة الأداء وأدوات البرمجة المرئية
- مشاريع توثيق أدوات التوثيق، مثل Redocly وMetanorma
كانت مشاريع النظام البيئي بايثون أكبر فئة فرعية. تضمنت المجموعة النموذجية لعام 2021 ArviZ وNumPy وMicroPython وPyMC3 وPyTorch-Ignite وSymPy.
لم نجمع أي بيانات وصفية حول المشاريع (مثل تاريخ التأسيس، أو التوزيع الجغرافي للمساهمين، أو عدد المساهمين أو حجم قاعدة المستخدمين).
طلبنا من المشروعات الإشارة إلى ترخيص البرامج المفتوحة المصدر الذي استخدموه.
إنّ مشاكل التوثيق التي أشارت إليها مؤسسات 2021 هي مشاكل شائعة جدًا في كلّ من المشاريع المفتوحة المصدر والوثائق الفنية بشكل عام.
تضمّنت أهم المشاكل التي كانت المؤسسات تأمل في حلها في برنامج عام 2021 ما يلي:
يُرجى العلم أنّه بإمكان المؤسسات الإبلاغ عن مشاكل متعددة في الوثائق. لمعرفة مزيد من التفاصيل، يمكنك الاطّلاع على صفحة نتائج Season of Docs لعام 2021، والتي تضم روابط إلى دراسات حالة كاملة لكل مؤسسة.
أنواع الوثائق التي تم إنشاؤها
كانت البرامج التعليمية أكثر أنواع الوثائق شيوعًا في دراسات الحالة لعام 2021.
تضمّنت أنواع المستندات الأخرى المذكورة في دراسات الحالة مسار إنشاء "مستندات Google" كرمز برمجي، ومخطّط بياني، ومسرد المصطلحات، ودليل الأسلوب، والأسئلة الشائعة، والتدويل، والدرس التطبيقي حول الترميز، ونموذج المحتوى، والوحدات، ووثائق المفاهيم، ورسائل الخطأ، وأبحاث المستخدمين، وملف تمهيدي، وقاعدة المعرفة.
بعض هذه الفئات ضبابية ويمكن أن يحتوي مشروع وثائق واحد على أنواع أو ميزات متعددة.
تمت الإشارة إلى العديد من المشاريع على وجه التحديد باستخدام إطار عمل Diátaxis كدليل لتخطيط أنواع الوثائق الخاصة بها.
لمعرفة مزيد من التفاصيل، يمكنك الاطّلاع على صفحة نتائج Season of Docs لعام 2021، والتي تضم روابط إلى دراسات حالة كاملة لكل مؤسسة.
الميزانيات
في عام 2021، بلغ متوسط طلب الميزانية 10,200 دولار أمريكي (أو ما يعادله بالعملة المحلية)، وبلغ المتوسط 10,000 دولار أمريكي (أو ما يعادله بالعملة المحلية). وقد طلبت ثلاث مؤسسات فقط وتلقت أقصى منحة ممكنة (15 ألف دولار أمريكي) وطلبت ثلاث مؤسسات أخرى الحصول على أقل منحة ممكنة (5 آلاف دولار أمريكي).
المقاييس
أوضحت المشروعات في دراسات الحالة المقاييس التي كانت تستخدمها لقياس نجاح مشروعات التوثيق الخاصة بها.
كانت أهم المقاييس المقترحة هي:
تضمنت المقاييس الأخرى المقترَحة نجوم GitHub، والوقت المستغرق في الصفحة، والإحالات الناجحة للقوائم البريدية، والاختبار النوعي للمستخدمين، وعدد المشاركين في المنتديات، وعدد الشركاء/المتطوعين/عمليات الدمج.
وبسبب الفترة القصيرة بين إنهاء مشاريع الكتابة الفنية وإرسال دراسات الحالة، لم تتمكّن معظم المجموعة النموذجية لعام 2021 من جمع بيانات كافية لتحديد ما إذا تم استيفاء مقاييسهم الأولية أم لا.
لمعرفة مزيد من التفاصيل، يمكنك الاطّلاع على صفحة نتائج Season of Docs لعام 2021، والتي تضم روابط إلى دراسات حالة كاملة لكل مؤسسة.
العمل مع الكتّاب التقنيين
كان التغيير الأكبر في برنامج Season of Docs في عام 2021 هو الطريقة التي تعاونت بها المشاريع مع الكتّاب التقنيين. وفي المواسم السابقة، تقدم الكتّاب التقنيون بطلب إلى Google مباشرةً، وكانت تتم مكافأتهم من قِبل مديري البرامج في المشاريع، وحصلوا على راتب ثابت من Google مباشرةً.
في عام 2021، قدّم المؤلفون التقنيون طلبًا إلى المشاريع مباشرةً، وحدّدت المشاريع الميزانية للحصول على تعويضات الكُتّاب التقنيين، مع المدفوعات التي يتم تسديدها من خلال صندوق Open Collective الخاص بـ Season of Docs.
كانت معظم المشروعات المشاركة في برنامج 2021 لديها خبرة قليلة أو معدومة في توظيف الكتّاب التقنيين أو توظيفهم، وذكرت العديد من المشروعات هذا الجزء من العملية على أنه يحتاج إلى مزيد من الدعم. استجابةً لهذه الملاحظات، أضاف فريق Season of Docs مستندات إنشاء اتفاقيات الكاتب التقني إلى دليل البرنامج.
اقتراحات التوظيف
طُلب من المشروعات تقديم توصيات للمشروعات الأخرى المهتمة بالمشاركة في Season of Docs. كانت أهم توصيات التوظيف هي:
- شارك مواد التوظيف للكتّاب التقنيين في أقرب وقت ممكن، حتى قبل قبولك في البرنامج. اطلب من مجتمعك إحالة المرشحين المحتملين.
- المشاركة على نطاق واسع خارج قنوات المشروع. استخدِم لغة شاملة وشجِّع المرشحين من خلفيات لا تحظى بالتمثيل الكافي للتقديم.
- تعرّف على الأدوات الضرورية لعملية إنشاء الوثائق وقم بتوظيف كتّاب تقنيين لديهم خبرة في استخدام هذه الأدوات.
- ضع توقعات واضحة للكاتب التقني حول المُخرَجات النهائية والمعالم الرئيسية، وقنوات الاتصال وعمليات التحقق، وعمليات الدفع والتوقيت.
- يمكنك الاستفادة من دعم أعضاء المنتدى ومساعدتهم على النمو في مجال كتابة المحتوى الفني من خلال الاستعانة بالكاتب التقني في Season of Docs لتقديم الإرشاد والتدريب.
- قم بتخصيص وقت أطول مما تتوقعه لتأهيل الكتّاب التقنيين والإجابة عن الأسئلة وتقديم الدعم أثناء البرنامج، خاصة إذا لم يكن لدى الكاتب الفني خبرة سابقة في مجال مشروعك.
- قم بتوثيق عملية التوظيف والتوظيف والإعداد لاستخدامها في المشروعات المستقبلية.
(ملاحظة: لم تتم الإشارة إلى جميع المشروعات في دراسات الحالة الخاصة بها حيث قاموا بتعيين المرشحين للكُتّاب الفنيين.)
المشاكل الشائعة في العمل مع الكتّاب التقنيين
واضطر الكتّاب التقنيون في عدة مشاريع إلى انسحابهم بسبب فيروس كورونا المستجد (كوفيد-19) أو أمراض أخرى، أو بسبب المسؤوليات العائلية المتعلقة بالجائحة. أبلغت بعض المشاريع عن مشاكل في الاتصالات تتضمّن حالات عدم تطابق في المنطقة الزمنية أو مشاكل في الاتصال بالإنترنت.
وجدت المشروعات أنها قللت من تقدير الصعوبات التي ينطوي عليها الإعداد في مجتمعاتها أو في إعداد سلسلة أدوات مستندات مشروعها.
كان هناك تأخير في بعض المشروعات في الدفع للمؤلفين التقنيين بسبب مشكلات مصرفية في Open Collective أو بسبب وجود قيود على الدفع في البلدان التي يقيم فيها المؤلفون.
لم تكن وثائق البرنامج حول رسوم Open Collective واضحة: لم تكن وثائق البرنامج المتعلقة برسوم Open Collective واضحة: فقد غطّت Google رسوم معاملات Open Collective مقابل التحويل الأولي للأموال إلى المشاريع، ولكنها لم تكن رسوم المعاملات التي تفرضها بعض قنوات الدفع الأخرى (مثل رسوم تحويل العملات). وسنعمل على توضيح ذلك بشكل أوضح في المستندات الخاصة بالبرامج المستقبلية.
استطلاعات المتابعة
وكجزء من برنامج "موسم المستندات"، طُلب من المشاريع المشاركة في استطلاعات المتابعة. تم إرسال ثلاثة استطلاعات في شهر أيار (مايو) وآب (أغسطس) وتشرين الثاني (نوفمبر) 2022.
طلب استطلاع المتابعة من المشروعات تأكيد أن روابط العرض ودراسة الحالة لا تزال نشطة. تضمن الاستبيان أيضًا أسئلة حول نجاح مشروعاتهم (على النحو المحدد من خلال المقاييس التي وضعوها في دراسة الحالة الخاصة بهم) والمشاركة المستمرة وتعويض الكتّاب الفنيين للمشروع:
- هل ما زلت تعمل مع الكاتب التقني في "الموسم من مستندات Google"؟
- إذا كان كاتبك الفني لا يزال يعمل في مشروعك، هل يتلقّى أي تعويضات بأي شكل من الأشكال؟
- في هذه المرحلة، هل تعتقد أنّ مشروع التوثيق ناجح؟
الأسئلة المستقبلية
كالعادة، كلما تعلمنا المزيد عن التوثيق في البرامج المفتوحة المصدر، زاد ما نريد أن نتعلمه! في المواسم القادمة، نأمل أن نتعرّف على ما يلي:
- ما إذا كانت نطاقات المشروع مرتبطة باختيار نوع المستند أو اختيار المقياس
- ما ممارسات توظيف الكتّاب التقنيين وإعدادهم هي الأكثر فعالية لإكمال المشروع والاحتفاظ بالكاتب الفني
- جداول زمنية معقولة لقياس فعالية التوثيق
على الرغم من وجود العديد من الأسئلة التي نود التحقيق فيها، فإننا نريد أيضًا أن نحترم وقت مشرفي المشروع مفتوح المصدر والقائمين على المشروع الذين يشاركون في Season of Docs. الأولوية القصوى للبرنامج هي دعم المشروعات في حل مشكلاتها باستخدام التوثيق.