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