المرحلة الحالية:
يتم الإعلان عن النتائج. اطّلِع على
المخطط الزمني.
استخدِم هذا المثال لمساعدتك في إنشاء تقرير دراسة الحالة الخاص بك.
PicklePlus: توثيق أداة المساهمة Glorious Pickle
المؤسسة أو المشروع: Glorious Pickle رابط إلى الموقع الإلكتروني الرئيسي لمؤسستك أو مشروعك هنا
وصف المؤسسة: Glorious Pickle (الإصدار الحالي 1.2.3، الإصدار الأول في عام 2009) هي مكتبة حاصلة على ترخيص من معهد ماساتشوستس للتكنولوجيا (MIT) لحساب النسبة المثالية من الملح والسكر والخل والتوابل لكل من الخضروات المخلّلة الممكنة، وذلك بكميات تتراوح بين خيار واحد صغير واحد من الخيار الصغير إلى حمولات من الفجل.
المؤلفون: اختياري: إدراج مؤلفي دراسة الحالة، واستخدام أسماء المستخدمين عند الطلب
بيان المشكلة أو ملخص الاقتراح
ما هي المشكلة التي كنت تحاول حلّها باستخدام مستندات جديدة أو محسّنة؟ أدرِج رابطًا يؤدي إلى صفحة الاقتراح على موقع مشروعك الإلكتروني، إن أمكن.
تعد إضافة مكونات إلى قاعدة بيانات مكونات أداة Glorious Pickle تستغرق وقتًا طويلاً ومعقدة، ولا تحتوي الأداة على وثائق جيدة. لا يملك العديد من المساهمين المحتمَلين خبرة في استخدام git أو تقديم طلبات السحب. وهذا يعني أنّ Glorious Pickle به فجوات كبيرة في بيانات المكونات، ويجعل أداتنا أقل فائدة. ومن خلال تحسين المستندات لإضافة مكونات جديدة، نأمل تشجيع المساهمين الجدد والمزيد من عملية تخليل الطعام.
وصف المشروع
إنشاء الاقتراح
كيف توصلت إلى اقتراح "موسم المستندات" من Google؟ ما العملية التي استخدمتها مؤسستك لاتخاذ قرار بشأن فكرة؟ كيف طلبت ملاحظات وتدمجها؟
استمعت قناة Glorious Pickle Pickledocs SIG عن برنامج Google Season of Docs من خلال تغريدة من مكتب البرامج مفتوحة المصدر لدى Google. ناقشت SIG البرنامج في اجتماعها النصف أسبوعين، ووافقت على إنشاء اقتراح. تطوع عضوان من SIG (@KimChiCook و @Dillicious) للعمل على مسودة الاقتراح لتتم مراجعتها في الاجتماع القادم.
بمجرد موافقة Pickledocs SIG على مسودة الاقتراح، تم إرسال رسالة بريد إلكتروني إلى المشروع الأوسع لطلب الملاحظات. وقدم أربعة عشر عضوًا في المجتمع الملاحظات، بما في ذلك @Glorious PicklePat، المشرف على واجهة برمجة التطبيقات الخاصة بإضافة المكونات. تطوع @Glorious PicklePat ليكون موردًا خلال البرنامج.
بعد مناقشة ودمج الملاحظات الواردة، تم إرسال الاقتراح إلى اللجنة التوجيهية لمشروع Glorious Pickle للتصويت عليها. صوّت الأعضاء الخمسة في لجنة GPPSC (GPPSC) +1 لإرسال الاقتراح والطلب، ووافق @VinegarViv على المساعدة في إنشاء حساب Open Collective المطلوب للمشاركة في البرنامج والإشراف على الدفعات.
الميزانية
أدرِج قسمًا قصيرًا في ميزانيتك. كيف قدرت العمل؟ هل كانت هناك أي نفقات غير متوقعة؟ هل انتهى بك الأمر إلى إنفاق أقل من جائزة المنحة؟ هل خصصت الأموال بشكل صحيح أم كانت بعض العناصر التي خصصت لها ميزانية أكثر/أقل/غير ضرورية؟ هل كان لديك أموال أخرى خارج "الموسم من مستندات Google" تمكَّنت من استخدامها؟
عمل اثنان من أعضاء Glorious Pickle Pickle Docs ككاتبين تقنيين (واحد في أوروبا والآخر في الأرجنتين). لقد ساعدنا في تقدير العمل والعثور على ميزانيات مشروع مماثلة، ومقارنة مسودة عمل الاقتراح الذي قاموا به من قبل. بقي لدينا أيضًا 1000 دولار أمريكي من أموال الرعاية غير المحدودة من مؤتمر PicklePals لعام 2019 الذي خصصناه للمشروع.
كانت النفقات غير المتوقعة تساعد الكاتب التقني في استئجار نقطة اتصال Wi-Fi، حيث كان في منطقة متضررة من حرائق الغابات وفقد الاتصال بالإنترنت في منزله. انتهى بنا الأمر أيضًا بإرسال عدد أقل من القمصان للمشاركين أكثر مما كنا نخطط له، لذلك كان ذلك متوازنًا.
بالإضافة إلى ذلك، قررنا تعويض إحدى المساهمين في GloriousTakele، وهي @Piccalily (التي كانت سابقًا محررة نُسخ محترفة في حياتها العادية) للمساعدة في تعديل المستندات التي أنشأها الكاتب الفني وتصحيحها.
مشارك
مَن الذي عمل في هذا المشروع (استخدِم أسماء المستخدمين إذا طلب ذلك المشاركون)؟ كيف عثرت على الكاتب التقني ووظّفته؟ كيف وجدت متطوعين آخرين أو مشاركين مدفوعين؟ ما الأدوار التي اضطلعوا بها؟ هل انسحاب أحد منكم؟ ماذا تعلمت حول التوظيف والتواصل وإدارة المشاريع؟
كان الفريق الأساسي الذي يعمل في هذا المشروع:
- @Dillicious، @KimChiCook (Buyle علاقة SIG)
- @Piccalily (copyeditor)
- @GherKen, @VinegarViv (مساعدة المشرف، GPPSC)
- @BBChips و @Glorious PicklePat (خبراء في الموضوع)
- سام سكريب (كاتب فنّي)
عثرنا على Sam Scribe من خلال قائمة مستودع GitHub لموسم المستندات من Google. اعتقدنا أن تجربته (عمل سام في مجلة للطهي بالإضافة إلى كتابة وثائق لمواقع الويب) تتوافق بشكل جيد مع مشروعنا. انضم سام إلى مكالمة Pickledocs SIG كل أسبوعين وتحدث معنا حول المشروع، وقدّم العديد من الاقتراحات القيّمة التي دمجناها في الاقتراح. تواصلنا أيضًا مع كتّاب تقنيين آخرين معروفين لنا من خلال شبكات أعضاء SIG، ولكن لم يكن أي منهما متاحًا خلال الفترة الزمنية للبرنامج.
نظرًا لأن المنطقة الزمنية لسامي تداخلت معها بضع ساعات فقط مع معظم أعضاء Pickle Docs SIG، فقد أرسلنا مكالمة في منتدى المناقشة إلى الأشخاص الذين كانوا في المنطقة الزمنية لسامي وعلى دراية بعملية إضافة المكونات. تطوَّع @BBChips للإجابة عن أسئلة "سام" ومساعدته في العثور على خبراء آخرين عند الحاجة. تطوّع @Glorious PicklePat أيضًا لمساعدة "سام" في فهم البنية الأساسية للأداة ورسائل الخطأ المحتملة من واجهة برمجة التطبيقات، وقدّم المساعدة إلى GitHub وgit.
لسوء الحظ، في منتصف الطريق للبرنامج @VinegarViv اضطر إلى التراجع عن المشروع لأسباب شخصية. سارع عضو GPPSC @GherKen في الإجابة عن الأسئلة الإدارية والأسئلة المتعلّقة بالدفع.
بعد طرح بعض الأسئلة غير الصائبة (يستخدم GloriousDiscoverle نسخة Slack مجانية وأحيانًا تتحرك المناقشة بسرعة كبيرة لدرجة أننا نفقد المحادثات بسبب الحد الأقصى للأرشفة) تعلّمنا أنّه يجب الاحتفاظ بقائمة من الأسئلة قيد التشغيل في مستند مشترك (استخدمنا مستند Google مشتركًا). قام أعضاء Pickledocs SIG بالتحقق من ذلك قبل كل اجتماع وحرصوا على الحصول على الإجابات قبل نهاية الاجتماع. تمكّن سامي من إرسال رسالة إلكترونية إلى @BBChips مباشرةً لطرح أي أسئلة عاجلة.
لقد كنا سعداء للغاية بالعمل مع سام وسام، بالإضافة إلى تحديث وثائق Glorious Pickle، فقد أصبحا أنفسهم من المطوّرين المتحمسين!
المخطط الزمني
قدِّم نظرة عامة قصيرة على المخطط الزمني لمشروعك (أشِر إلى تاريخ الانتهاء المقدَّر أو المراحل المتوسطة في حال كان المشروع مستمرًا).
بينما كنا ننتظر برنامج Google Season of Docs للإعلان عن المؤسسات المشاركة، بحث أعضاء Pickle Docs SIG عن أي عمل سابق رأينا أنه سيكون مفيدًا لسام. على مدار شهر، عثرنا على بعض الملاحظات من الجهود السابقة لتعديل المستندات المتوقّفة، كما تعاونّا في مراجعة أجزاء من مواد التدقيق المرتبطة بالمستندات في مستودع opendocs من Google.
بمجرد وصولنا إلى الأخبار السارة التي تفيد بأنه تم اختيارنا للمشاركة في Season of Docs من Google، التقى "سام" مع Pickle Docs SIG وقاموا بوضع جدول زمني تقريبي:
| مسرح | تم إكماله من قِبل |
|---|---|
| مراجعة تدقيق المستندات | 7 أيار (مايو) |
| حالات استخدام سجل الاحتكاك 3 | 14 أيار (مايو) |
| مراجعة سجلات الاحتكاك مع @Glorious PicklePat و @BBChips والإجابة عن الاستفسارات | 28 أيار (مايو) |
| المسودة الأولى لحالة الاستخدام 1 للمستندات المعدَّلة | 25 حزيران (يونيو) |
| تمت مراجعة مسودة حالة الاستخدام 1 من قِبل @Glorious PicklePat و @KimChiCook | 2 تموز (يوليو) |
| المسودة الأولى لحالة استخدام المستندات المعدّلة 2 | 2 تموز (يوليو) |
| تمت مراجعة مسودة حالة الاستخدام 2 من قِبل @Glorious PicklePat و @Dillicious | 9 تموز (يوليو) |
| المسودة الأولى لحالة الاستخدام 3 للمستندات المعدَّلة | 9 تموز (يوليو) |
| تمت مراجعة مسودة حالة الاستخدام 3 من قِبل @Dillicious و @KimChiCook | 16 يوليو |
| إجابات عن كل طلبات البحث في كل حالات الاستخدام | 30 تموز (يوليو) |
| معظم صانعي المحتوى في Pickle Docs 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، كما ذكر مساهم جديد في تعليق على العلاقات العامة لديه الذي جرّبه من قبل ولكنه لم يكمل التحديث لأنه لم يفهم العملية.
التحليل
ما الأمور التي سارت على ما يرام؟ ما الذي كان غير متوقع؟ ما هي العقبات أو الانتكاسات التي واجهتها؟ هل تعتبر مشروعك ناجحًا؟ أذكر السبب في كلتي الحالتين (إذا كان الوقت مبكرًا جدًا لمعرفة ذلك، يمكنك توضيح الوقت الذي تتوقّع فيه أن تتمكّن من الحكم على نجاح مشروعك.)
نحن سعداء جدًا بنتائج مشروع "موسم المستندات" من Google ونعتبره ناجحًا. المستندات الجديدة واضحة ومفيدة، وقد شهدنا زيادة في عدد طلبات السحب المرتبطة بالمكوّنات وفي عدد طلبات السحب من المساهمين الجدد.
وكنا سعداء أيضًا بمشاركة منتدى Glorious Pickle بالكامل تقريبًا من خلال تقديم ملاحظات حول الاقتراح الأصلي واختبار المستندات الجديدة في شكل مسودة.
لقد واجهنا بعض العقبات غير المتوقعة، كنا ممتنين لأن حرائق الغابات في ولاية سام لم تتسبب في ضرر أكثر من انقطاع الإنترنت! كنّا أيضًا نشعر بالأسف لفقدان @VinegarViv من المشروع، ونتمنّى لها ولعائلتها أفضل التوفيق ونأمل أن تراها مرة أخرى قريبًا.
شيء واحد لم ندركه حتى بدأ سام العمل على التوثيق هو عدد المصطلحات والاختصارات ذات الصلة بالمخللات التي لن تكون غير مألوفة لشخص يأتي إلى مشروعنا ليس لديه خلفية عن اختيار المواد. ومع ذلك، قرر سام الحفاظ على قائمة بكل مصطلح غير مألوف وعرّفها من خلال أبحاثه الخاصة ومن خلال طلب التفسيرات والمراجع من أعضاء المنتدى. سيساعدك مسرد مصطلحات Pickle هذا بشكل كبير في الترحيب بالمزيد من الأشخاص في مجتمع التخليل في المستقبل.
ملخّص
لخِّص تجربتك في المشروع في فقرة أو 4 فقرات. سلط الضوء على ما تعلمته، وما الذي قد تختار القيام به بشكل مختلف في المستقبل. ما هي النصيحة التي تقدّمها لمشاريع أخرى تحاول حلّ مشكلة مماثلة في التوثيق؟
باختصار، كانت تجربتنا رائعة! لقد حققنا إنجازاتنا في الوثائق ويبدو أن مقاييسنا متوافقة مع أهدافنا.
كان الجزء الأكبر من نجاح هذا المشروع هو مدى حظنا في العمل مع الكاتب التقني لدينا، "سام سكريب". [لم أكتب هذا — سام] على الرغم من أن سام لم يكن لديه خلفية في الاختيار أو الخبرة مع GitHub، ككاتب تقني خبير، كان يشعر بالراحة في التعمق في مجال موضوع جديد، وطرح الأسئلة، وإجراء الأبحاث. لم يختر "سام" سريعًا أدوات المشروع فقط (نستخدم لوحة Kanban لتتبّع الأعمال)، بل ونلّكات مرحة أيضًا. نحن سعداء جدًا لأنّ سام قد اكتشف حشرة التخليل وأنّنا زعجنا هذا الخطأ في مجتمعنا.
وننصح المشروعات الأخرى بما يلي:
- اجعل اقتراحاتك صغيرة وقابلة للإدارة. (أردنا في الأصل تضمين الوثائق المتعلقة باستخدام أداة التقدير الخاصة بنا مع آلات المجففة الصناعية في اقتراحنا، ولم نستبعدها إلا لأن أحد أعضاء المنتدى المنخرط في استخدام آلات خليط من المصادر مفتوحة المصدر كان سيكتب رسالة الدكتوراه خلال البرنامج.) انتهى بنا الأمر إلى أكثر من عمل كافٍ لإبقاء سام مشغولاً!
- استفِد من شبكاتك الإعلانية عند البحث عن كاتب تقني. اطلب من كل فرد في منتدى قناتك تقديم اقتراحات. على الرغم من أننا وجدنا "سام" من خلال "موسم Google" في GitHub، إلا أننا شعرنا بالثقة في العمل معهم لأننا تحدثنا مع العديد من الأشخاص أثناء فترة تقديم الطلب.
- رحِّب بالكاتب التقني في المنتدى. أبلغنا سام أن الموقف الحماسي لمحبي Glorious Picklers جعل من السهل طرح الأسئلة.
- ساعد الكاتب التقني في اكتساب مهارات مفتوحة المصدر. لم يسبق أن استخدم "سام" منصة git من قبل، ولكن بعد الاطّلاع على بعض البرامج التعليمية، تمكّن من الإتقان بسرعة. في البداية، كان سمير قلقًا بشأن مقدار الملاحظات التي قد يتلقّاها من المنتدى وكيفية الاستفادة منها، ولكن نموذج "الإجماع التقريبي" الذي اعتمده المنتدى ("يتم تحقيق الإجماع عند معالجة جميع المشاكل، ولكن ليس بالضرورة استيعابها") جعل "سام" واثقًا من معالجة الانتقادات استنادًا إلى خبرته في الكتابة الفنية.
الملحق
إذا كان لديك مواد أخرى تريد إنشاء روابط تؤدي إليها (على سبيل المثال، إذا أنشأت عقدًا للعمل مع الكاتب الفني الذي تريد مشاركته أو نماذج لمشروع الوثائق أو غيرها من موارد التوثيق المفتوحة، يمكنك إدراجها وربطها هنا). يشكّل "الملحق" أيضًا مكانًا مناسبًا لسرد روابط لأي أدوات توثيق أو مراجع استخدمتها، أو مكان لإضافة الشكر أو الشكر والتقدير قد لا يتناسب مع الفقرات أعلاه.
خدمات الإقرار
يريد فريقنا الاعتراف بما يلي للأشخاص والأشياء التالية:
- تعبّر @Dillicious عن شكرها لشريكها وإلى راديو موسيقى الهيب هوب منخفض الدقة.
- يود @KimChiCook أن يشكر صاحب قناة 할머니 بحيث علّمه كيفية المخلل.
- نودّ أن تشكر صاحبة قناة @Piccalily دليل شيكاغو الخاص بالأسلوب على الإنترنت.
- يود @GherKen أن يشكر أطفاله الثلاثة على تناول جميع المخللات التي يمكنه صنعها
- يود @VinegarViv أن يشكر بقية أعضاء الفريق على الموافقة على انسحابها.
- يود @BBChips تقديم الشكر إلى أفضل طعام متاح بدون المخبوزات، وهو رقائق الكراميل من تونوك.
- يود @Glorious PicklePat أن يشكر Pickledocs SIG لتوليه هذا المشروع
- يشكر "سام سكريب" جميع أفراد منتدى Glorious Pickle بالكامل، ولكن لا سيّما الذين أرسلوا لهم أوعية تعليب خلال صيف 2021، وهم في طريقهم إلى تناول العديد من المخلّلات اللذيذة.