المرحلة الحالية:
انتهى برنامج "موسم المستندات" لعام 2021 في 14 كانون الأول (ديسمبر) 2021. اطّلِع على
المخطط الزمني.
استخدِم هذا المثال لمساعدتك في إنشاء تقرير دراسة الحالة الخاص بك.
PicklePlus: توثيق أداة المساهمة GloriousPickle
المؤسسة أو المشروع: Glorious Pickle يؤدي إلى الموقع الإلكتروني الرئيسي لمؤسستك أو مشروعك هنا
وصف المؤسسة: GloriousPickle (الإصدار الحالي 1.2.3، الإصدار الأول في عام 2009) هي مكتبة مرخّصة من MIT لاحتساب نسبة الملح والسكر والخل والتوابل بسهولة لكلّ نوع من الخضروات التي يمكن تخليلها، بكميات تتراوح بين خيار صغير فردي وحمولات حاويات من الفجل.
المؤلفون: اختياري: إدراج أسماء مؤلفي دراسة الحالة، واستخدام الأسماء المعرِّفة إذا طُلب ذلك
بيان المشكلة/ملخّص الاقتراح
ما هي المشكلة التي حاولت حلها باستخدام المستندات الجديدة أو المحسنة؟ أدرِج رابطًا يؤدي إلى صفحة الاقتراح على موقع مشروعك الإلكتروني، إن أمكن.
إنّ إضافة المكونات إلى قاعدة بيانات المكونات في أداة GloriousPickle تستغرق وقتًا طويلاً وهي عملية معقّدة، ولا تتضمّن الأداة مستندات جيدة. لا يملك العديد من المشارِكين المحتملين خبرة في استخدام git أو تقديم طلبات سحب. وهذا يعني أنّ Glorious Pickle يتضمّن فجوات كبيرة في بيانات المكوّنات، ما يجعل الأداة أقل فائدة. من خلال تحسين مستندات إضافة مكونات جديدة، نأمل أن نشجّع المساهمين الجدد على إضافة المزيد من الوصفات.
وصف المشروع
إنشاء الاقتراح
كيف استلهمت فكرة اقتراحك لـ "موسم المستندات"؟ ما هي العملية التي اتّبعتها مؤسستك لاختيار فكرة؟ كيف طلبت الملاحظات وأدرجتها؟
علم فريق GloriousPickle PickleDocs SIG ببرنامج "موسم المستندات" من خلال تغريدة من مكتب البرامج المفتوحة المصدر في Google. ناقش فريق SIG البرنامج في اجتماعه الذي يُعقد كل أسبوعَين، واتفق على إنشاء اقتراح. تطوع اثنان من أعضاء شركة SIG (@KimChiCook و @Dillicious) للعمل على مسودة الاقتراح لمراجعته في الاجتماع التالي.
بمجرد موافقة Pickle Docs SIG على مسودة الاقتراح، تم إرسال رسالة بريد إلكتروني إلى المشروع الأوسع لطلب الملاحظات. قدّم أربعة عشر عضوًا في المنتدى ملاحظاتهم، بما في ذلك @GloriousPicklePat، وهو المشرف على واجهة برمجة التطبيقات لإضافة المكونات. تطوّعت @GloriousPicklePat لتوفير معلومات خلال البرنامج.
بعد مناقشة الملاحظات التي تمّ تلقّيها ودمجها، تم إرسال الاقتراح إلى لجنة توجيه مشروع GloriousPickle للتصويت عليه. صوّت جميع الأعضاء الخمسة في GPPSC بـ "+1" لإرسال الاقتراح والطلب، ووافقت مستخدمة تويتر @VinegarViv على المساعدة في إنشاء حساب Open Collective المطلوب للمشاركة في البرنامج والإشراف على الدفعات.
الميزانية
أدرِج قسمًا قصيرًا عن ميزانيتك. كيف قدّرت العمل؟ هل كانت هناك أي نفقات غير متوقّعة؟ هل انتهى بك الأمر بإنفاق مبلغ أقل من مبلغ المنحة؟ هل كانت لديك أموال أخرى خارج "موسم المستندات" تمكّنت من استخدامها؟
عمل اثنان من أعضاء مجموعة التركيز GloriousPickle PickleDocs ككاتبَين فنيين (أحدهما في أوروبا والآخر في الأرجنتين). لقد ساعدتنا في تقدير العمل والعثور على ميزانيات مشاريع مشابهة، وذلك من خلال مقارنة مسودة العمل الذي تم تقديمه في السابق. كان لدينا أيضًا مبلغ 1,000 دولار أمريكي من أموال الرعاية غير المقيّدة من مؤتمر PicklePals لعام 2019، وقد خصصناها للمشروع.
أدت نفقات غير متوقعة إلى مساعدة الكاتب التقني على استئجار نقطة اتصال wifi، أثناء تواجده في منطقة متأثرة بحرائق الغابات وقطع الاتصال بالإنترنت في منزله. وانتهى بنا الأمر أيضًا بإرسال عدد أقل من القمصان إلى المشاركين مما خططنا له، لذلك توازنت الأمور.
بالإضافة إلى ذلك، قررنا تعويض أحد المساهمين في Glorious Pickle، وهو @Piccalily (التي كانت سابقًا محررة محترفة في حياتها غير المهنية) للمساعدة في تعديل المستندات التي أنشأها الكاتب التقني وتدقيقها وتصحيحها.
مشارك
مَن عمل على هذا المشروع (يُرجى استخدام أسماء المستخدمين إذا طلب المشاركون ذلك)؟ كيف عثرت على الكاتب الفني ووظّفته؟ كيف عثرت على متطوعين أو مشاركين مدفوعِين آخرين؟ ما هي الأدوار التي كان يؤديها؟ هل انسحب أحدهم؟ ماذا تعلمت عن التوظيف والتواصل وإدارة المشاريع؟
كان الفريق الأساسي الذي يعمل في هذا المشروع هو:
- @Dillicious و@KimChiCook (مجموعة عمل PickleDocs)
- @Piccalily (copyeditor)
- @GherKen، @VinegarViv (مساعدة المشرف، GPPSC)
- @BBChips و@GloriousPicklePat (خبراء في الموضوع)
- سام سكريب (كاتب فني)
عثرنا على سام سكريب من خلال قائمة مستودع GitHub الخاص بموسم المراجع. ورأينا أنّ خبرته (عمل سام في مجلة طهي بالإضافة إلى كتابة مستندات لمواقع إلكترونية) تتوافق بشكل جيد مع مشروعنا. انضم سام إلى المكالمة التي تُعقد كل أسبوعَين في مجموعة PickleDocs SIG وناقش معنا المشروع، وقدم عدة اقتراحات قيّمة جدًا دمجناها في الاقتراح. تواصلنا أيضًا مع كاتبَين فنيين آخرين نعرفهما من خلال شبكات أعضاء مجموعة SIG، ولكن لم يكن أيّ منهما متاحًا خلال الفترة الزمنية للبرنامج.
بما أنّ المنطقة الزمنية لسام تتداخل مع معظم أعضاء مجموعة PickleDocs SIG لبضع ساعات فقط، أرسلنا دعوة في منتدى المناقشة لمستخدمي Picklers الذين كانوا في المنطقة الزمنية لسام وعلى دراية بعملية إضافة المكونات. تطوعت @BBChips بالإجابة عن أسئلة سام ومساعدتها في العثور على خبراء آخرين حسب الحاجة. تطوع أيضًا @GloriousPicklePat لمساعدة سام في فهم البنية الأساسية للأداة ورسائل الخطأ المحتمَلة من واجهة برمجة التطبيقات، كما قدّم مساعدة بشأن GitHub وgit.
لسوء الحظ، في منتصف الطريق اضطر @VinegarViv إلى التراجع عن المشروع لأسباب شخصية. سارع عضو GPPSC @GherKen إلى الرد على الأسئلة الإدارية والأسئلة المتعلقة بالدفع.
بعد الاطّلاع على بعض الأسئلة الفائتة (يستخدم Glorious Pickle مثيلاً مجانيًا من Slack في بعض الأحيان، وتتحرك المناقشة بسرعة كبيرة لدرجة أنّنا نفقد المحادثات بسبب الحدّ الأقصى للأرشفة، علمنا أنّه علينا الاحتفاظ بقائمة بالأسئلة الجارية في مستند مشترك (استخدمنا مستند Google مشترك). راجع أعضاء برنامج Pickle Docs SIG هذا الأمر قبل كلّ اجتماع، وحرصوا على الحصول على الإجابات قبل نهاية الاجتماع. تمكّن "سام" من إرسال رسالة إلى فريق @BBChips مباشرةً للإجابة عن الأسئلة العاجلة.
لقد سررنا جدًا بالعمل مع "سام" و"سام". بالإضافة إلى تعديل مستندات Glorious Pickle، تحوّلنا إلى صانع محتوى نشط بشغف كبير.
المخطط الزمني
قدِّم نظرة عامة موجزة على المخطط الزمني لمشروعك (حدِّد تاريخ الانتهاء المقدَّر أو المعالم الرئيسية الوسيطة إذا كان المشروع لا يزال جاريًا).
أثناء انتظارنا إعلان برنامج "موسم المستندات" عن المؤسسات المشاركة، أجرى أعضاء مجموعة PickleDocs SIG بحثًا عن أي عمل سابق نعتقد أنّه سيكون مفيدًا لـ "سام". على مدار شهر، عثرنا على بعض الملاحظات من محاولة سابقة لتعديل المستندات التي توقّفت، وعملنا أيضًا على أجزاء من مواد تدقيق مستوى نضج المستندات في مستودع Google opendocs.
بعد أن تلقّينا الأخبار السارة بأنّنا تم اختيارنا لبرنامج "موسم المستندات" لعام 2021، التقى سام ومجموعة PickleDocs SIG ووضعوا جدولاً زمنيًا تقريبيًا:
| مسرح | تم إكماله بواسطة |
|---|---|
| مراجعة تدقيق المستندات | 7 مايو |
| حالات استخدام سجلّ الاحتكاك 3 | 14 أيار (مايو) |
| مراجعة سجلّات المشاكل مع @GloriousPicklePat و @BBChips والإجابة عن الاستفسارات | 28 أيار (مايو) |
| المسودة الأولى لحالة استخدام المستندات المعدَّلة 1 | 25 حزيران (يونيو) |
| مسودة حالة الاستخدام 1 التي راجعها @GloriousPicklePat و@KimChiCook | 2 تموز (يوليو) |
| المسودة الأولى لحالة استخدام المستندات المُعدَّلة 2 | 2 تموز (يوليو) |
| مسودة حالة الاستخدام 2 التي راجعها @GloriousPicklePat و@Dillicious | 9 تموز (يوليو) |
| المسودة الأولى لحالة استخدام المستندات المعدَّلة 3 | 9 تموز (يوليو) |
| مسودة حالة الاستخدام 3 التي راجعها @Dillicious و@KimChiCook | 16 تموز (يوليو) |
| الإجابة عن جميع طلبات البحث في جميع حالات الاستخدام | 30 تموز (يوليو) |
| كانت معظم مجموعات PickleDocs SIG في إجازة من 1 إلى 20 آب (أغسطس) | -- |
| بدء اختبار المستندات الجديدة في المنتدى (المستندات المنشورة كمسودات على موقع GloriousPickle الإلكتروني) | 21 آب (أغسطس) |
| دمج ملاحظات الاختبار | 10 أيلول (سبتمبر) |
| التدقيق اللغوي ومراجعة المستندات الجديدة | 17 أيلول (سبتمبر) |
| إزالة حالة "مسودة" من المستندات وإطلاقها رسميًا | 28 أيلول (سبتمبر) |
| عملية تعديل المستندات التي تم إنشاؤها | 1 نوفمبر |
| تم إنشاء دراسة الحالة هذه | 8 نوفمبر |
| تم إرسال دراسة الحالة. | 16 تشرين الثاني (نوفمبر) |
في ميزانية الاقتراح، قدّرنا أنّ الكاتب الفني سيقضي من 10 إلى 15 ساعة في الأسبوع في العمل على مشروعنا. احتفظ سام بسجلّات للوقت الذي يقضيه في العمل، وبلغ متوسط الوقت الذي يقضيه في العمل 11.5 ساعة في الأسبوع.
النتائج
ما الذي تم إنشاؤه أو تعديله أو تغييره؟ أدرِج روابط تؤدي إلى المستندات المنشورة، إن توفّرت. هل كان هناك أيّ مهام مطلوبة في الاقتراح لم يتمّ إنشاؤها؟ أدرِج هذه العناصر أيضًا.
تمّت توثيق ثلاث حالات استخدام رئيسية مع أدلة إرشادية كاملة للمستخدمين:
كيفية إضافة مكوّن جديد إلى GloriousPickle
كيفية إضافة مكوّنات متغيّرة إلى Glorious Pickle
كيفية تعديل أو تصحيح مكوّن في GloriousPickle
تضمّنت هذه الأدلّة أيضًا نماذج جديدة لطلبات السحب لتسهيل المساهمات.
بالإضافة إلى ذلك، أنشأ سام خلال المشروع مسردًا صغيرًا للمصطلحات التي تعلمها، وتم نشره أيضًا على موقع مشروع GloriousPickle الإلكتروني.
أضفنا إرشادات لتحديث أدلة المستخدم الإرشادية هذه لموقع wiki لمشروعنا.
لقد أدرجنا إنشاء جدول مرجعي للمشاركين الجدد في GitHub لمساعدتهم في استخدام عملياتنا وأدواتنا، ولكن بعد الاطّلاع على الموارد المتاحة، تمكّنا من إنشاء جدول مرجعي لمشروع آخر بدلاً من ذلك.
المقاييس
ما هي المقاييس التي اخترتها لقياس نجاح المشروع؟ هل تمكّنت من جمع هذه المقاييس؟ هل كانت المقاييس مرتبطة بشكل جيد أو سيئ بالنتائج التي أردت تحقيقها للمشروع؟ هل تغيّرت المقاييس منذ تقديم الاقتراح؟
في اقتراحنا، اقترحنا مقياسَين:
- عدد طلبات سحب البيانات ذات الصلة بالمكوّنات
- عدد طلبات سحب الرمز البرمجي من المساهمين الجدد
في شهر أيلول (سبتمبر)، وهو أول شهر كامل منذ نشر مسودة المستندات، شهدنا زيادةً بنسبة% 5 في طلبات سحب البيانات المتعلّقة بالمكوّنات (من 20 طلبًا في آب (أغسطس) إلى 21 طلبًا في أيلول (سبتمبر))، وثلاثة مساهمين جدد قدّموا أربعة طلبات سحب بيانات في المجمل (مقارنةً بمساهمَين جديدَين قدّما طلبَي سحب بيانات في آب (أغسطس)). نخطّط لتتبُّع هذه المقاييس شهريًا.
اعتبارًا من 1 كانون الثاني (يناير)، سنبدأ أيضًا بتتبُّع عدد المساهمين الذين قدّموا أكثر من ثلاث مساهمات بشكل عام، وذلك كل ثلاثة أشهر بعد نشر المستندات.
نعتقد أنّ هذه المستندات الجديدة قد أحدثت فرقًا في تمكين المساهمين الجدد من إضافة معلومات إلى قاعدة بيانات مكونات GloriousPickle. فقد ذكر أحد المساهمين الجدد في تعليقه على قسم العلاقات العامة أنّه حاول ذلك من قبل ولكنّه لم يكمل تعديله لأنّه لم يكن يفهم العملية.
التحليل
ما هي الأمور التي سارت على ما يرام؟ ما الذي لم يكن متوقّعًا؟ ما هي العقبات أو الانتكاسات التي واجهتها؟ هل تعتبر مشروعك ناجحًا؟ ما سبب ذلك؟ (إذا كان من السابق لأوانه تحديد ذلك، اشرح متى تتوقّع أن تتمكّن من تقييم نجاح مشروعك).
نحن سعداء جدًا بنتيجة مشروع "موسم المستندات" ونعتبره ناجحًا. الوثائق الجديدة واضحة ومفيدة، وقد شهدنا بالفعل بعض التطور في عدد طلبات السحب المتعلقة بالمكونات وعدد طلبات السحب من المساهمين الجدد.
لقد سرّنا أيضًا أنّ منتدى GloriousPickle بأكمله تقريبًا شارك في هذه العملية، من خلال تقديم ملاحظات حول الاقتراح الأصلي واختبار المستندات الجديدة في شكل مسودة.
واجهنا بعض العقبات غير المتوقّعة، وكنا ممتنّين لأنّ الحرائق البرية في ولاية سام لم تتسبّب في أي ضرر أكبر من انقطاع الإنترنت. بالإضافة إلى ذلك، يؤسفنا فقدان @VinegarViv من المشروع، ونتمنّى لها ولعائلتها أفضل التوفيق ونأمل أن تراها مرة أخرى قريبًا.
لم نكن ندرك عدد المصطلحات والاختصارات المتعلّقة بالتخليل التي قد تكون غير مألوفة لشخص لا يملك أيّ خبرة في هذا المجال، إلى أن بدأ سام العمل على المستندات. ومع ذلك، حرص سام على الاحتفاظ بقائمة بكل مصطلح غير مألوف وتحديد معانيه من خلال أبحاثه الخاصة وطلب تفسيرات وإحالات من أعضاء المنتدى. سيكون مسرد مخللات هذا مفيدًا جدًا في جذب المزيد من الأشخاص إلى منتدى المخللات في المستقبل.
ملخّص
لخِّص تجربتك في مشاريعك في فقرتَين و4 فقرات. وضِّح ما تعلمته وما ستختار فعله بشكل مختلف في المستقبل. ما هي النصيحة التي تقدّمها للمشاريع الأخرى التي تحاول حلّ مشكلة مشابهة في المستندات؟
باختصار، كانت تجربتنا رائعة. لقد حققنا المُخرَجات النهائية المتعلّقة بالمستندات، ويبدو أنّ مقاييسنا متوافقة مع أهدافنا.
يعود جزء كبير من نجاح هذا المشروع إلى حظنا الجيد في العمل مع الكاتب الفني سام سكرابي. [لم أكتب هذا السطر، سام] على الرغم من أنّ سام لم يكن لديه خبرة في مجال التخمير أو استخدام GitHub، إلا أنّه كان يشعر بالارتياح عند التعمّق في موضوع جديد وطرح الأسئلة وإجراء الأبحاث، وذلك بفضل خبرته في الكتابة الفنية. سرعان ما تعلّم سام استخدام أدوات المشاريع (نحن نستخدم لوحة Kanban لتتبُّع العمل) بالإضافة إلى نكات المخلل. يسعدنا جدًا أنّ سام قد أنشأ قناة لنشر محتوى حول المخللات وأنّنا "أودعناه" في منتدانا.
ننصح المشروعات الأخرى باتّباع الخطوات التالية:
- يجب أن تكون الاقتراحات صغيرة وقابلة للإدارة. (أردنا في الأصل تضمين مستندات لاستخدام أداة التقدير مع آلات التصنيع التلقائي للتخليل في اقتراحنا، ولم نُدرِجها إلا لأنّ إحدى أعضاء المنتدى المشارِكة بشكل كبير في آلات التصنيع التلقائي للتخليل كانت ستكتب أطروحة الدكتوراه خلال البرنامج). لقد انتهى بنا الأمر بتوفير ما يكفي من العمل لإبقاء سام مشغولاً.
- استخدِم شبكاتك عند البحث عن كاتب فني. اطلب من جميع أفراد المنتدى تقديم اقتراحات. على الرغم من أنّنا عثرنا على سام من خلال GitHub في "موسم "مستندات Google"، شعرنا بالثقة في العمل معه لأنّنا تحدثنا مع عدة أشخاص خلال فترة تقديم الطلبات.
- نرحّب بالكاتب الفني في منتدى قناتك. أخبرنا سام أنّ الموقف الحماسي لمقدّمي السبّاقين سهّل عليهم طرح الأسئلة.
- ساعد الكاتب الفني في اكتساب مهارات استخدام البرامج مفتوحة المصدر. لم يسبق لسام استخدام git، ولكن بعد الاطّلاع على بعض الأدلة التعليمية، تمكّن من استخدام الأداة بسرعة. في البداية، كان سام قلقًا بشأن مقدار الملاحظات التي قد يتلقّاها من المنتدى وكيفية دمجها، ولكنّ نموذج "التوافق التقريبي" في المنتدى ("يتحقق التوافق عند معالجة جميع المشاكل، ولكن ليس بالضرورة الاستجابة لها") جعله واثقًا من معالجة الانتقادات باستخدام خبرته في الكتابة الفنية.
الملحق
إذا كانت لديك مواد أخرى تريد الربط بها (على سبيل المثال، إذا أنشأت عقد عمل مع الكاتب الفني الذي تريد مشاركته، أو نماذج لمشروع التوثيق، أو موارد أخرى متاحة للجميع، يمكنك إدراجها وربطها هنا). يُعدّ "الملحق" أيضًا مكانًا جيدًا لسرد روابط إلى أيّ أدوات أو موارد مستندية استخدمتها، أو مكانًا لإضافة شكر أو إقرار مساهمة قد لا يناسب الأقسام أعلاه.
خدمات الإقرار
يريد فريقنا الاعتراف بالأشخاص والعناصر التالية:
- تودّ @Dillicious شكر شريكها وأيضًا راديو موسيقى "هيب هوب" منخفض الدقة
- يريد @KimChiCook شكر 할머니 على تعليمه كيفية تخليل الخضار.
- شكرًا من @Piccalily إلى Chicago Manual of Style Online
- يود @GherKen أن يشكر أطفاله الثلاثة على تناول كل المخللات التي يمكنه صنعها.
- تريد @VinegarViv أن تشكر بقية أعضاء الفريق على تسهيل عملية تنحيها.
- نودّ أن نشكر على تويتر @BBChips على أفضل طعام غير مخلل متوفّر، وهو ويفرات الكراميل من Tunnock.
- يود @Glorious PicklePat تقديم الشكر لشركة Pickle Docs SIG على تولّيه هذا المشروع.
- يعبّر "سام سكريب" عن شكره لجميع أفراد منتدى Glorious Pickle، وكذلك أعضاء الفريق الذين أرسلوا لهم أوانٍ تعليب في صيف 2021، بدءًا من رحلتهم إلى العديد من المخللات اللذيذة.