المرحلة الحالية:
تطوير المستندات: يمكنك الاطّلاع على المخطط الزمني.
استخدم هذا المثال لمساعدتك على إنشاء تقرير دراسة الحالة الخاص بك.
PicklePlus: توثيق أداة Glorious Pickle Contributionle
المؤسسة أو المشروع: Glorious Pickle رابط إلى الموقع الإلكتروني الرئيسي لمؤسستك أو مشروعك هنا
وصف المؤسسة: Glorious Pickle (الإصدار الحالي 1.2.3، الإصدار الأول في عام 2009) هي مكتبة حاصلة على ترخيص من معهد ماساتشوستس للتكنولوجيا (MIT) لاحتساب النسبة المثالية من الملح والسكر والخل والتوابل لكل خضروات مخلّلة ممكنة، وذلك بكميات تتراوح بين خيار واحد صغير من الخيار الصغير إلى أحمال شحن الفجل.
المؤلفون: اختياري: إدراج مؤلفي دراسة الحالة، واستخدام أسماء المستخدمين عند الطلب
بيان المشكلة أو ملخص الاقتراح
ما هي المشكلة التي كنت تحاول حلّها باستخدام مستندات جديدة أو محسَّنة؟ أدرِج رابطًا يؤدي إلى صفحة الاقتراح على موقع المشروع الإلكتروني، إن أمكن.
تعد إضافة المكونات إلى قاعدة بيانات مكونات أداة Glorious Pickle وقتًا طويلاً ومعقدًا، ولا تحتوي الأداة على وثائق جيدة. فالعديد من المساهمين لا يمتلكون خبرة في استخدام git أو تقديم طلبات السحب. وهذا يعني أن Glorious Pickle به فجوات خطيرة في بيانات المكونات الخاصة بنا، ويجعل أداتنا أقل فائدة. من خلال تحسين الوثائق الخاصة بإضافة مكونات جديدة، نأمل أن نشجع المساهمين الجدد والمزيد من عملية الحلاقة.
وصف المشروع
إنشاء الاقتراح
كيف توصلت إلى اقتراح موسم Google من "مستندات Google"؟ ما العملية التي استخدمتها مؤسستك لاتخاذ قرار بشأن فكرة؟ كيف طلبت ملاحظات وتدمجها؟
سمعت Glorious PickleTakele Docs SIG عن برنامج "موسم Google" من المستندات من خلال تغريدة من مكتب البرامج المفتوحة المصدر في Google. ناقشت SIG البرنامج في اجتماعها كل أسبوعين، ووافقت على إنشاء اقتراح. تطوع اثنان من SIG (@KimChiCook و @Dillicious) للعمل على مسودة الاقتراح لمراجعتها في الاجتماع القادم.
بمجرد موافقة Pickledocs SIG على مسودة الاقتراح، تم إرسال رسالة بريد إلكتروني إلى المشروع الأوسع لطلب الملاحظات. قدَّم أربعة عشر فردًا من أعضاء المنتدى ملاحظات، بما في ذلك @Glorious PicklePat، وهو المشرف على واجهة برمجة التطبيقات الخاصة بإضافة المكونات. تطوَّع @Glorious PicklePat ليكون موردًا خلال البرنامج.
بعد مناقشة ودمج الملاحظات الواردة، تم إرسال الاقتراح إلى اللجنة التوجيهية لمشروع Glorious Pickle للتصويت. صوّت جميع الأعضاء الخمسة في GPPSC +1 لإرسال الاقتراح والطلب، ووافق @VinegarViv على المساعدة في إنشاء حساب Open Collective المطلوب للمشاركة في البرنامج والإشراف على الدفعات.
الميزانية
أدرِج قسمًا قصيرًا في ميزانيتك. كيف قدرت العمل؟ هل كانت هناك أي نفقات غير متوقعة؟ هل انتهى بك الأمر بإنفاق أقل من جائزة المنحة؟ هل خصصت الأموال بشكل صحيح أم كانت بعض العناصر التي خصصتها لها أكثر/أقل/غير ضرورية؟ هل كان لديك أموال أخرى غير متاحة لك خارج موسم "مستندات Google" من Google؟
وعمل عضوان من Glorious Pickle Docs SIG ككاتب فني (أحدهما في أوروبا والآخر في الأرجنتين). لقد ساعدنا في تقدير العمل والعثور على ميزانيات مشروع مماثلة، ومقارنة مسودة عمل الاقتراح الذي قاموا به من قبل. يتبقى لدينا أيضًا 1000 دولار أمريكي من أموال الرعاية غير المحدودة من مؤتمر PicklePals لعام 2019 الذي خصصناه للمشروع.
كانت النفقات غير المتوقعة تساعد الكاتب التقني في استئجار نقطة اتصال Wi-Fi، أثناء تواجده في منطقة متأثرة بحرائق الغابات وفقدان إمكانية الوصول إلى الإنترنت في منزله. انتهى بنا أيضًا الأمر بإرسال عدد أقل من القمصان إلى المشاركين أكثر مما كنا نخطط، لذلك كان الأمر متوازنًا.
بالإضافة إلى ذلك، قررنا تعويض مساهمة Glorious Pickle، وهي @Piccalily (التي كانت سابقًا محررة إعلانات محترفة في حياتها العادية) للمساعدة في تحرير وتنقيح المستندات التي أنشأها الكاتب الفني.
مشارك
من عمل في هذا المشروع (استخدِم أسماء المستخدمين إذا طلب ذلك المشاركون)؟ كيف عثرت على الكاتب الفني ووظّفته؟ كيف وجدت متطوعين آخرين أو مشاركين آخرين يدفعون مقابل العمل؟ ما الأدوار التي كان لديهم؟ هل انسحب أي شخص؟ ماذا تعلمت حول التوظيف والتواصل وإدارة المشاريع؟
كان الفريق الأساسي الذي يعمل في هذا المشروع هو:
- @Dillicious، @KimChiCook (Pickle نريد SIG)
- @Piccalily (copyeditor)
- @GherKen، @VinegarViv (مساعدة المشرف، GPPSC)
- @BBChips، @Glorious PicklePat (خبراء في الموضوع)
- سام سكرير (كاتب فني)
لقد عثرنا على Sam Scribe من خلال قائمة مستودع GitHub ضمن "موسم المستندات" من Google. اعتقدنا أن تجربته (عمل سام في مجلة للطهي بالإضافة إلى كتابة وثائق لمواقع الويب) تتطابق بشكل جيد مع مشروعنا. انضم "سام" إلى مكالمة Pickle Docs SIG كل أسبوع وتحدّث معنا خلال المشروع وقدّم عدة اقتراحات قيّمة جدًا قمنا بدمجها في الاقتراح. تواصلنا أيضًا مع كتابَين تقنيَّين آخرَين معروفَين لدينا من خلال شبكات أعضاء SIG، ولكن لم يكن أي منهما متاحًا خلال الفترة الزمنية للبرنامج.
نظرًا لأن المنطقة الزمنية لسامح لم تتداخل سوى بضع ساعات مع معظم أعضاء Pickle Docs SIG، أرسلنا مكالمة في منتدى المناقشة الخاص بنا لـ Picklers الذين كانوا في المنطقة الزمنية لسام وعلى دراية بعملية إضافة المكونات. تطوع @BBChips للإجابة عن أسئلة "سام" ومساعدته في العثور على خبراء آخرين حسب الحاجة. تطوّع أيضًا @GloriousThinklePat لمساعدة "سام" في فهم البنية الأساسية للأداة ورسائل الخطأ المحتمَلة من واجهة برمجة التطبيقات، وقدّم المساعدة إلى GitHub وgit.
لسوء الحظ، اضطرر في منتصف البرنامج @VinegarViv إلى التراجع عن المشروع لأسباب شخصية. انتقل عضو GPPSC @GherKen إلى الإجابة عن الأسئلة الإدارية وأسئلة الدفع.
وبعد طرح بعض الأسئلة غير الصائبة (يستخدم GloriousAttributele نسخة مجانية من Slack وأحيانًا تتحرّك المناقشة بسرعة كبيرة لدرجة أننا نفقد المحادثات بسبب الحد الأقصى للأرشفة)، وتعلمنا أنّه يجب علينا الاحتفاظ بقائمة بالأسئلة قيد التشغيل في مستند مشترك (استخدمنا مستند Google مشترك). قام أعضاء Pickledocs SIG بفحصها قبل كل اجتماع وحرصوا على الحصول على الإجابات قبل نهاية الاجتماع. تمكّن سام من إرسال رسالة إلكترونية إلى @BBChips مباشرةً لطرح أي أسئلة عاجلة.
كنا سعداء جدًا بالعمل مع سام وسام، بالإضافة إلى تحديث وثائق Glorious Pickle، فقد أصبح نفسهما من الخبراء النهمين!
المخطط الزمني
قدِّم نظرة عامة قصيرة على المخطط الزمني لمشروعك (وضِّح تاريخ الانتهاء المقدّر أو المراحل الرئيسية المتوسطة إذا كان المشروع جاريًا).
بينما انتظرنا برنامج Google Season of Docs للإعلان عن المؤسسات المشاركة، أجرى أعضاء Pickle Docs SIG بحثًا عن أي عمل سابق رأينا أنه سيكون مفيدًا لسام. على مدار شهر، عثرنا على بعض الملاحظات من جهود سابقة لتعديل المستندات التي توقّفت، وعملنا أيضًا على مراجعة أجزاء من مواد التدقيق الخاصة بمدى ترجمة المحتوى في مستودع Google opendocs.
بعد وصولنا الأخبار السارة التي تفيد بأنّه تم اختيارنا للمشاركة في موسم Google Docs، التقى سامي وPele الاشتراك SIG وعمل جدول زمني تقريبي:
| مسرح | تم إكماله من قِبل |
|---|---|
| مراجعة تدقيق المستندات | 7 أيار (مايو) |
| حالات استخدام سجل الاحتكاك 3 | 14 أيار (مايو) |
| مراجعة السجلات المعقّدة باستخدام @Glorious PicklePat و @BBChips، ويمكنك الإجابة عن الطلبات | 28 أيار (مايو) |
| المسودة الأولى لحالة الاستخدام المعدّلة للمستندات | 25 حزيران (يونيو) |
| تمت مراجعة مسودة حالة الاستخدام 1 من قِبل @GloriousStaylePat و @KimChiCook. | 2 تموز (يوليو) |
| المسودة الأولى لحالة استخدام المستندات المحدّثة 2 | 2 تموز (يوليو) |
| تمت مراجعة مسودة حالة الاستخدام 2 من قِبل @Glorious PicklePat و @Dillicious. | 9 تموز (يوليو) |
| المسودة الأولى لحالة استخدام المستندات المحدّثة 3 | 9 تموز (يوليو) |
| تمت مراجعة مسودة حالة الاستخدام 3 من قِبل @Dillicious و @KimChiCook. | 16 تموز (يوليو) |
| كل طلبات البحث التي تمت الإجابة عنها في جميع حالات الاستخدام | 30 تموز (يوليو) |
| معظم صانعي المحتوى في Pickleالمستندات SIG في عطلة من 1 إلى 20 آب (أغسطس) | -- |
| بدء اختبار المستندات الجديدة في المنتدى (المستندات المنشورة كمسودات على موقع Glorious Pickle) | 21 آب (أغسطس) |
| تضمين الملاحظات الاختبارية | 10 أيلول (سبتمبر) |
| نسخ تعديل وتدقيق المستندات الجديدة | 17 أيلول (سبتمبر) |
| تمت إزالة حالة المسودة للمستندات، وإطلاق المستندات رسميًا | 28 أيلول (سبتمبر) |
| تم إنشاء عملية تعديل الوثائق. | 1 تشرين الثاني (نوفمبر) |
| تم إنشاء دراسة الحالة هذه | 8 تشرين الثاني (نوفمبر) |
| تم إرسال دراسة الحالة | 16 نوفمبر |
في ميزانية عرضنا، قدرنا أن الكاتب الفني سيقضي من 10 إلى 15 ساعة أسبوعيًا في العمل على مشروعنا. احتفظ سام بسجلات للوقت الذي قضاه، وبلغ متوسطها 11.5 ساعة في الأسبوع.
النتائج
ما الذي تم إنشاؤه أو تعديله أو تغييره بأي شكل آخر؟ أدرِج روابط إلى المستندات المنشورة إن توفّرت. هل كانت هناك أي مخرجات نهائية في الاقتراح لم يتم إنشاؤها؟ أدرِجها أيضًا.
تم توثيق ثلاث حالات استخدام رئيسية باستخدام الأدلة الإرشادية الكاملة للمستخدم:
طريقة إضافة مكوّن جديد إلى Glorious Pickle
كيفية إضافة مكوّن مختلف إلى منتجات Glorious Pickle
كيفية تعديل أحد المكوّنات أو تصحيحه في Glorious Pickle
تضمّنت هذه الأدلّة أيضًا نماذج جديدة لطلبات سحب المساهمات لتسهيل المساهمات.
بالإضافة إلى ذلك، خلال المشروع، أنشأ سام مسرد مصطلحات صغيرًا تعلمه مجموعة Pickle، والذي تم نشره أيضًا على موقع مشروع Glorious Pickle.
أضفنا إرشادات لتحديث أدلة إرشادات المستخدم هذه إلى موقع wiki لمشروعنا.
لقد قمنا بتضمين إنشاء ورقة معلومات مرجعية للمساهمين الجدد على GitHub لمساعدتهم على استخدام عملياتنا وأدواتنا، ولكن بمجرد النظر في الموارد المتاحة، تمكنا من تسجيل ورقة المعلومات المرجعية لمشروع آخر بدلاً من ذلك.
المقاييس
ما هي المقاييس التي اخترتها لقياس نجاح المشروع؟ هل تمكنت من جمع هذه المقاييس؟ هل ترتبط المقاييس بشكل جيد أم سيئ بالنتائج التي تريدها للمشروع؟ هل تغيّرت المقاييس منذ تقديم الاقتراح؟
في اقتراحنا، اقترحنا مقياسين:
- عدد طلبات السحب المتعلقة بالمكوّنات
- عدد طلبات السحب من المساهمين الجدد
وفي شهر أيلول (سبتمبر) (وهو الشهر الأول بالكامل منذ نشر مسودة المستندات)، شهدنا زيادة بنسبة 5% في طلبات السحب المتعلقة بالمكوّنات (من 20 آب (أغسطس) إلى 21 أيلول (سبتمبر)) ورأينا ثلاثة مساهمين جُدد قدَّموا أربعة طلبات سحب إجمالية (مقارنةً بمساهمَين جديدَين قدّما طلبَي سحب في آب (أغسطس). نخطط لتتبُّع هذه المقاييس شهريًا.
واعتبارًا من 1 كانون الثاني (يناير)، سنتتبّع أيضًا عدد المساهمين الذين قدّموا أكثر من ثلاث مساهمات بشكل عام، وذلك اعتبارًا من ربع السنة بعد نشر المستندات.
وعلى نحو بديهي، نعتقد أنّ هذه المستندات الجديدة أحدثت فارقًا في تمكين المساهمين الجدد من الإضافة إلى قاعدة بيانات مكونات Glorious Pickle، حيث ذكر مساهم جديد في تعليق على صفحة العلاقات العامة (PR) الذي جربه من قبل ولكن لم يكمل التعديل بسبب عدم فهمه للعملية.
التحليل
ما الأمور التي سارت على ما يرام؟ ما الذي كان غير متوقع؟ ما هي العقبات أو الانتكاسات التي واجهتها؟ هل تعتبر مشروعك ناجحًا؟ ما سبب ذلك؟ (إذا كان ذلك مبكرًا جدًا، فاشرح الوقت الذي تتوقّع فيه أن تتمكّن من الحكم على نجاح مشروعك.)
نحن سعداء للغاية بالنتائج التي حققها مشروع Google Season of Docs ونعتبره ناجحًا. إنّ المستندات الجديدة واضحة ومفيدة، وقد لاحظنا بالفعل بعض الزيادة في عدد طلبات السحب المرتبطة بالمكوّنات وفي عدد طلبات السحب من المساهمين الجدد.
سعدنا أيضًا بمشاركة مجتمع Glorious Pickle بالكامل تقريبًا عن طريق تقديم ملاحظاتك حول الاقتراح الأصلي واختبار المستندات الجديدة في شكل مسودة.
لقد واجهنا بعض العقبات غير المتوقعة، ونحن ممتنون لأن حرائق الغابات في ولاية سام لم تتسبب في أي ضرر أكبر من انقطاع الإنترنت! أيضًا، كنّا نشعر بالأسف لفقدان @VinegarViv من المشروع، ونتمنى لها ولعائلتها التوفيق والنجاح، ونأمل أن نتمكّن من رؤيتها مجددًا قريبًا.
الشيء الوحيد الذي لم ندركه حتى بدأ سام في العمل على التوثيق هو عدد المصطلحات والاختصارات ذات الصلة بالمخللات التي ستكون غير مألوفة لشخص يأتي إلى مشروعنا وليس لديه خلفية للتخمير. مع ذلك، أشار "سام" إلى الاحتفاظ بقائمة بكل العبارات غير المألوفة وعرّفها من خلال أبحاثه الخاصة ومن خلال طلب تفسيرات ومراجع من أعضاء المنتدى. سيساعدك مسرد المصطلحات هذا في الترحيب بالمزيد من الأشخاص في مجتمع المخلص في المستقبل.
ملخّص
لخص تجربتك في المشروع في فقرتين أو 4 فقرات. سلِّط الضوء على ما تعلمته، وما الذي قد تختار القيام به بشكل مختلف في المستقبل. ما هي النصيحة التي تقدّمها للمشاريع الأخرى التي تحاول حلّ مشكلة مشابهة باستخدام الوثائق؟
باختصار، تجربتنا كانت شيّقة. لقد حققنا مخرجاتنا النهائية ويبدو أن مقاييسنا متوافقة مع أهدافنا.
كان جزء كبير من نجاح هذا المشروع هو مدى حظوظنا في العمل مع الكاتب الفني لدينا، سام سكريبي. [لم أكتب هذا — سام] على الرغم من أن سام لم يكن لديه خلفية في التخلّص أو الخبرة مع GitHub، بصفته كاتبًا تقنيًا خبيرًا، إلا أنه كان يشعر بالارتياح للتعمق في مجال جديد، وطرح الأسئلة، وإجراء الأبحاث. سرعان ما لم يختار سام أدوات المشروع فقط (نستخدم لوحة Kanban لتتبع العمل) ولكن أيضًا نكاتنا المضحكة! نحن سعداء للغاية لأنّ سامي قد اكتشف حشرة الحلاقة وأنّنا "عملنا" على "عملائها" في منتدانا.
ننصح المشروعات الأخرى بما يلي:
- اجعل اقتراحاتك صغيرة وسهلة الإدارة. (أردنا في الأصل تضمين الوثائق المتعلقة باستخدام المُثمّر الخاص بنا مع آلات المجففة الصناعية في اقتراحنا، ولم نتوقف عن ذلك إلا لأن أحد أعضاء مجتمعنا المنخرطين بشكل كبير في آلات المخلل المفتوحة المصدر كان سيكتب رسالة الدكتوراه خلال البرنامج). انتهى بنا الأمر إلى العمل أكثر من اللازم لإبقاء سام مشغولاً!
- استفد من شبكاتك عند البحث عن كاتب تقني. اطلب اقتراحات من كل فرد في مجتمعك. على الرغم من أننا عثرنا على سام من خلال موسم Google من GitHub، إلا أننا شعرنا بالثقة في العمل معهم لأننا تحدثنا مع العديد من الأشخاص خلال فترة تقديم الطلب.
- رحِّب بالكاتب التقني في المنتدى. أخبرنا سام أن الموقف الحماسي لمصنعي Glorious Picklers جعل من السهل طرح الأسئلة.
- ساعِد الكاتب الفني في اكتساب مهارات مفتوحة المصدر. لم يسبق أن استخدم سامي تقنية git من قبل، ولكن بعد الاطلاع على بعض البرامج التعليمية، استطاع تعلّم المزيد بسرعة. في البداية، كان "سام" قلقًا بشأن مقدار الملاحظات التي قد يتلقّاها المنتدى وكيفية الاستفادة منها، لكن نموذج "الإجماع التقريبي" الذي اعتمده المنتدى ("يتم تحقيق الإجماع عند معالجة جميع المشاكل، وليس بالضرورة استيعابها)"، جعل "سام" واثقًا من التعامل مع الانتقادات باستخدام خبرته الفنية في الكتابة.
الملحق
إذا كان لديك مواد أخرى تريد الربط بها (على سبيل المثال، إذا أنشأت عقدًا للعمل مع الكاتب الفني الذي تريد مشاركته، أو نماذج لمشروع المستندات، أو غيرها من موارد المستندات المفتوحة، يمكنك إدراجها وربطها هنا). يشكّل "الملحق" أيضًا مكانًا مناسبًا لإدراج الروابط المؤدية إلى أي أدوات أو موارد وثائق استخدمتها، أو مكان لإضافة شكر أو شكر قد لا يتناسب مع الأقسام أعلاه.
خدمات الإقرار
يرغب فريقنا في تقدير الأشخاص والأشياء التالية:
- تشكر صاحبة قناة @Dillicious شريكها وأيضًا راديو موسيقى "هيب هوب" منخفض الدقة.
- يودّ @KimChiCook أن يشكره 할머니 على تعليمه طريقة المخلل.
- يود @Piccalily أن يشكر دليل شيكاغو للأزياء على الإنترنت.
- يودّ @GherKen أن يشكر أطفاله الثلاثة على تناول جميع المخللات التي يمكنه صنعها
- تود @VinegarViv أن تشكر بقية أعضاء الفريق على موافقتهم على انسحابها.
- يود @BBChips الشكر إلى أفضل طعام متوفّر بدون المخبوزات، وهو رقائق الكراميل من Tunnock.
- يودّ @GloriousStaylePat أن يشكر صاحب قناة Pickle Docs SIG على جهوده في هذا المشروع.
- يودّ "سام سكريبي" أن يشكر جميع أفراد منتدى GloriousStayle، ولا سيّما عملاء بيكلر الذين أرسلوا لهم أوعية تعليب خلال صيف عام 2021، وبدأوا رحلتهم على الطريق إلى العديد من المخللات اللذيذة.