فاز فعلی:
توسعه اسناد و مدارک جدول زمانی را ببینید.
از این مثال برای کمک به ایجاد گزارش مطالعه موردی خود استفاده کنید.
PicklePlus: Documenting The GloriousPickle Contribution Tool
سازمان یا پروژه: لینک Glorious Pickle به سایت اصلی سازمان یا پروژه شما در اینجا
توضیحات سازمان: GloriousPickle (نسخه فعلی 1.2.3، اولین انتشار در سال 2009) یک کتابخانه دارای مجوز MIT برای محاسبه آسان نسبت کامل نمک، شکر، سرکه، و ادویه جات ترشی جات برای هر سبزی ترشی ممکن، در مقادیر مختلف از یک انفرادی. بچه خیار به ظرف-کشتی از تربچه.
نویسندگان: اختیاری: فهرست نویسندگان مطالعه موردی. در صورت درخواست از نام کاربری استفاده کنید
چکیده بیان مسئله/پیشنهاد
چه مشکلی را با اسناد جدید یا بهبودیافته حل می کردید؟ در صورت امکان به صفحه پیشنهاد در سایت پروژه خود پیوند دهید.
افزودن مواد تشکیل دهنده به پایگاه داده مواد تشکیل دهنده ابزار GloriousPickle زمان بر و پیچیده است و این ابزار مستندات خوبی ندارد. بسیاری از مشارکت‌کنندگان بالقوه تجربه استفاده از git یا درخواست‌های کشش را ندارند. این بدان معناست که GloriousPickle شکاف های جدی در داده های مواد تشکیل دهنده ما دارد و ابزار ما را کمتر مفید می کند. با بهبود مستندات برای افزودن مواد جدید، امیدواریم مشارکت کنندگان جدید و ترشی بیشتر را تشویق کنیم!
شرح پروژه
ایجاد پروپوزال
چگونه به پیشنهاد Google Season of Docs رسیدید؟ سازمان شما از چه فرآیندی برای تصمیم گیری در مورد یک ایده استفاده کرده است؟ چگونه بازخورد را درخواست کردید و از آنها استفاده کردید؟
GloriousPickle PickleDocs SIG از طریق توییتی از دفتر برنامه‌های منبع باز Google درباره برنامه فصل اسناد Google شنید. SIG این برنامه را در جلسه دوهفته ای خود مورد بحث قرار داد و با ایجاد یک پیشنهاد موافقت کرد. دو عضو SIG (@KimChiCook و @Dillicious) داوطلب شدند تا روی پیش‌نویس پیشنهادی برای بررسی در جلسه بعدی کار کنند.
هنگامی که PickleDocs SIG با پیش‌نویس پیشنهاد موافقت کرد، ایمیلی به پروژه گسترده‌تر ارسال شد و درخواست بازخورد داشت. چهارده عضو انجمن، از جمله @GloriousPicklePat، نگهدارنده API افزودن مواد، بازخورد ارائه کردند. @GloriousPicklePat داوطلب شد تا در طول برنامه یک منبع باشد.
پس از بحث و بررسی و ترکیب بازخوردهای دریافتی، این پیشنهاد برای رای گیری به کمیته راهبری پروژه GloriousPickle ارسال شد. همه پنج عضو GPPSC به ارسال پیشنهاد و برنامه رای +1 دادند و @VinegarViv موافقت کرد که به ایجاد حساب Open Collective مورد نیاز برای شرکت در برنامه و نظارت بر پرداخت‌ها کمک کند.
بودجه
یک بخش کوتاه در مورد بودجه خود بگنجانید. کار را چگونه ارزیابی کردید؟ آیا هزینه های غیرمنتظره ای وجود داشته است؟ آیا در نهایت کمتر از جایزه کمک هزینه کردید؟ آیا بودجه را به درستی تخصیص دادید یا مواردی که برای آنها بیشتر/کمتر/غیرضروری در نظر گرفته بودید؟ آیا بودجه دیگری خارج از فصل سندنگار Google داشتید که بتوانید از آنها استفاده کنید؟
دو عضو GloriousPickle PickleDocs SIG به عنوان نویسندگان فنی (یکی در اروپا و دیگری در آرژانتین) کار کرده اند. آنها به ما کمک کردند تا کار را تخمین بزنیم و بودجه های پروژه مشابهی را پیدا کنیم و پیش نویس کار پیشنهادی را که قبلا انجام داده بودند مقایسه کنیم. ما همچنین 1000 دلار از پول حمایت نامحدود از کنوانسیون PicklePals خود در سال 2019 باقی مانده بود که به پروژه اختصاص دادیم.
هزینه‌ای پیش‌بینی نشده کمک به نویسنده فنی ما برای اجاره یک نقطه اتصال Wi-Fi بود، زیرا آنها در منطقه‌ای تحت تأثیر آتش‌سوزی قرار داشتند و دسترسی به اینترنت در خانه خود را از دست دادند. همچنین در نهایت به ارسال تی شرت های کمتری برای شرکت کنندگان نسبت به آنچه که برنامه ریزی کرده بودیم، رسیدیم، بنابراین به تعادل رسیدیم.
علاوه بر این، ما تصمیم گرفتیم به یکی از مشارکت کنندگان GloriousPickle، @Piccalily (که زمانی یک ویرایشگر حرفه ای در زندگی غیر ترشی خود بود) برای کمک به ویرایش و تصحیح اسناد ایجاد شده توسط نویسنده فنی غرامت بدهیم.
شركت كنندگان
چه کسی روی این پروژه کار کرده است (در صورت درخواست شرکت کنندگان از نام کاربری استفاده کنید)؟ چگونه نویسنده فنی خود را پیدا کردید و استخدام کردید؟ چگونه سایر داوطلبان یا شرکت کنندگان پولی را پیدا کردید؟ چه نقش هایی داشتند؟ کسی ترک تحصیل کرد؟ در مورد استخدام، ارتباطات و مدیریت پروژه چه آموختید؟
تیم اصلی کار بر روی این پروژه عبارت بودند از:
- @Dillicious، @KimChiCook (PickleDocs SIG)
- @Piccalily (ویرایشگر کپی)
- @GherKen، @VinegarViv (کمک مدیر، GPPSC)
- @BBChips، @GloriousPicklePat (کارشناسان موضوع)
- سام اسکریب (نویسنده فنی)
ما Sam Scribe را از طریق فهرست مخزن Google Season of Docs GitHub پیدا کردیم. ما فکر کردیم که تجربه آنها (سام برای یک مجله آشپزی و همچنین نوشتن اسناد برای وب سایت ها کار کرده است) با پروژه ما مطابقت دارد. سام به تماس دوهفته‌ای PickleDocs SIG پیوست و در طول پروژه با ما صحبت کرد و چندین پیشنهاد بسیار ارزشمند ارائه داد که ما در پروپوزال گنجانده‌ایم. ما همچنین از طریق شبکه های اعضای SIG خود با دو نویسنده فنی دیگر آشنا شدیم، اما هیچکدام در طول زمان برنامه در دسترس نبودند.
از آنجایی که منطقه زمانی سم فقط چند ساعت با اکثر اعضای PickleDocs SIG همپوشانی داشت، ما در انجمن گفتگوی خود تماسی برای Picklerهایی که در منطقه زمانی سام بودند و با فرآیند افزودن مواد آشنا بودند، ارسال کردیم. @BBChips داوطلب شد تا به سؤالات سام پاسخ دهد و در صورت نیاز به آنها کمک کند تا کارشناسان دیگر را پیدا کنند. @GloriousPicklePat همچنین داوطلب شد تا به سام در درک معماری زیربنایی ابزار و پیام‌های خطای احتمالی از API کمک کند و به GitHub و git کمک کرد.
متأسفانه، در اواسط راه برنامه @VinegarViv مجبور شد به دلایل شخصی از پروژه عقب نشینی کند. عضو GPPSC @GherKen برای رسیدگی به سوالات اداری و پرداخت اقدام کرد.
پس از چند سؤال از دست رفته (GloriousPickle از نمونه رایگان Slack استفاده می کند و گهگاه بحث آنقدر سریع پیش می رود که به دلیل محدودیت بایگانی متحرک، مکالمات را از دست می دهیم) متوجه شدیم که باید فهرستی از سؤالات در حال اجرا را در یک سند مشترک نگه داریم (ما از Google مشترک استفاده کردیم. دکتر). اعضای PickleDocs SIG قبل از هر جلسه آن را بررسی می کردند و مطمئن می شدند که قبل از پایان جلسه پاسخ دریافت می کردند. سام می‌توانست مستقیماً برای سؤالات فوری به @BBChips پینگ کند.
ما از کار با سام بسیار خوشحال بودیم و سام، علاوه بر به روز رسانی مستندات GloriousPickle، خود به یک ترشی مشتاق تبدیل شده است!
جدول زمانی
یک نمای کلی کوتاه از جدول زمانی پروژه خود ارائه دهید (تاریخ پایان تخمینی یا نقاط عطف میانی اگر پروژه در حال انجام است را مشخص کنید).
در حالی که منتظر بودیم تا برنامه فصل Google Docs سازمان‌های شرکت‌کننده را معرفی کند، اعضای PickleDocs SIG هر کار قبلی را که فکر می‌کردیم برای سام مفید باشد جستجو کردند. در طول یک ماه، یادداشت‌هایی از تلاش‌های قبلی برای به‌روزرسانی اسناد متوقف شده بود، و همچنین روی بخش‌هایی از مواد حسابرسی سررسید اسناد در مخزن Google opendocs کار کردیم.
هنگامی که خبر خوشی را دریافت کردیم که برای فصل Google Docs انتخاب شده‌ایم، سم و PickleDocs SIG با هم ملاقات کردند و برنامه‌ریزی دقیقی را انجام دادند:
| صحنه | تکمیل شده توسط |
|---|---|
| بررسی ممیزی اسناد | 7 می |
| موارد استفاده از اصطکاک log 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 اضافه کنیم
چگونه می توان یک ماده متفاوت را به GloriousPickle اضافه کرد
نحوه به روز رسانی یا تصحیح یک عنصر در GloriousPickle
این راهنماها همچنین شامل الگوهای جدید درخواست کشش برای تسهیل مشارکت می‌باشند.
علاوه بر این، در طول پروژه، سام یک واژه نامه کوچک Pickle از اصطلاحاتی که یاد گرفتند، ایجاد کرد که در سایت پروژه GloriousPickle نیز منتشر شد.
ما دستورالعمل هایی را برای به روز رسانی این راهنمای کاربر به ویکی پروژه خود اضافه کردیم.
ما ایجاد یک برگه تقلب برای مشارکت‌کنندگان جدید در GitHub را در نظر گرفته بودیم تا به آنها کمک کنیم از فرآیندها و ابزارهای ما استفاده کنند، اما وقتی منابع موجود را بررسی کردیم، توانستیم برگه تقلب پروژه دیگری را به جای آن فورک کنیم.
معیارهای
چه معیارهایی را برای سنجش موفقیت پروژه انتخاب کردید؟ آیا توانستید آن معیارها را جمع آوری کنید؟ آیا معیارها با نتایجی که برای پروژه می‌خواستید همبستگی خوبی داشتند یا ضعیف؟ آیا معیارهای شما از زمان پیشنهاد شما تغییر کرده است؟
در پیشنهاد خود، دو معیار را پیشنهاد کردیم:
- تعداد درخواست های کشش مرتبط با مواد تشکیل دهنده
- تعداد درخواست های جذب از مشارکت کنندگان جدید
برای ماه سپتامبر (اولین ماه کامل از زمان انتشار اسناد پیش‌نویس) شاهد افزایش 5 درصدی درخواست‌های جذب مرتبط با مواد بودیم (از 20 در آگوست تا 21 سپتامبر) و شاهد سه مشارکت‌کننده جدید بودیم که در مجموع 4 مشارکت داشتند. درخواست‌های کشش (در مقابل دو مشارکت‌کننده جدید که در ماه اوت دو درخواست کشش ارائه کردند). ما قصد داریم ماهانه این معیارها را دنبال کنیم.
از اول ژانویه، ما همچنین تعداد مشارکت‌کنندگانی را که در مجموع بیش از سه مشارکت داشته‌اند، هر سه ماه پس از انتشار مستندات، پیگیری می‌کنیم.
به طور حکایتی، ما معتقدیم که این مستندات جدید تفاوتی در ایجاد امکان افزودن مشارکت کنندگان جدید به پایگاه داده عناصر GloriousPickle ایجاد کرده است - یکی از مشارکت کنندگان جدید در نظر روابط عمومی خود ذکر کرد که قبلاً تلاش کرده بودند اما به روز رسانی خود را تکمیل نکرده بودند زیرا آنها این کار را انجام نداده بودند. فرآیند را درک کنید.
تحلیل و بررسی
چی خوب شد؟ چه چیزی غیر منتظره بود؟ با چه موانع یا مشکلاتی مواجه شدید؟ آیا پروژه خود را موفق می دانید؟ چرا و چرا نه؟ (اگر هنوز برای گفتن زود است، توضیح دهید که چه زمانی انتظار دارید بتوانید موفقیت پروژه خود را قضاوت کنید.)
ما از نتیجه پروژه Google Season of Docs خود بسیار خرسندیم و آن را موفقیت آمیز می دانیم. مستندات جدید واضح و مفید است و ما قبلاً شاهد رشدی در تعداد درخواست‌های کشش مرتبط با مواد و تعداد درخواست‌های کشش از سوی مشارکت‌کنندگان جدید بوده‌ایم.
ما همچنین خوشحال بودیم که تقریباً کل جامعه GloriousPickle از طریق ارائه بازخورد در مورد پیشنهاد اصلی و آزمایش اسناد جدید به صورت پیش نویس در آن شرکت کردند.
ما با چند مانع غیرمنتظره روبرو شدیم - قدردان بودیم که آتش‌سوزی‌های جنگلی در ایالت سام خسارتی بیشتر از قطع اینترنت نداشت! همچنین، متاسفیم که @VinegarViv را از پروژه از دست دادیم. ما برای او و خانواده اش آرزوی بهترین ها را داریم و امیدواریم به زودی دوباره او را ببینیم.
چیزی که ما تا زمانی که سم شروع به کار بر روی مستندات نکرد متوجه نشدیم این بود که چه تعداد از اصطلاحات و کلمات اختصاری مربوط به ترشی برای کسی که بدون سابقه ترشی وارد پروژه ما می شود ناآشنا است. با این حال، سام به حفظ فهرستی از هر اصطلاح ناآشنا اشاره کرد و آنها را با تحقیقات خود و با درخواست از اعضای جامعه برای توضیحات و مراجع تعریف کرد. این واژه نامه ترشی کمک بزرگی به استقبال افراد بیشتری از جامعه ترشی در آینده خواهد بود.
خلاصه
در 2-4 پاراگراف، تجربه پروژه خود را خلاصه کنید. آنچه را که آموخته‌اید و آنچه را که در آینده انجام می‌دهید برجسته کنید. چه توصیه ای به پروژه های دیگری که سعی در حل مشکل مشابه با مستندسازی دارند می دهید؟
در یک کلام، تجربه ما ترشی بود! ما به اسناد تحویلی خود دست یافتیم و به نظر می رسد معیارهای ما مطابق با اهداف ما باشد.
بخش بزرگی از موفقیت این پروژه این بود که چقدر خوش شانس بودیم که با نویسنده فنی خود، سم اسکریب کار کردیم. [این را ننوشتم - سام] اگرچه سام هیچ پیشینه ای در ترشی یا تجربه با GitHub نداشت، به عنوان یک نویسنده فنی با تجربه، آنها راحت در یک موضوع جدید شیرجه می زدند، سؤال می پرسیدند و تحقیق می کردند. سام به سرعت نه تنها ابزارهای پروژه ما (ما از یک صفحه کانبان برای پیگیری کار استفاده می کنیم) بلکه جوک های ترشی ما را نیز به کار گرفت! ما بسیار خوشحالیم که سام حشره ترشی را گرفتار کرده و آنها را در جامعه خود "بطری" کرده ایم.
ما به پروژه های دیگر توصیه می کنیم:
- پیشنهادات خود را کوچک و قابل مدیریت نگه دارید. (ما در ابتدا می‌خواستیم مستنداتی را برای استفاده از تخمین‌گر خود با ماشین‌های ترشی دسته‌ای صنعتی در پروپوزال خود لحاظ کنیم، و تنها به این دلیل آن را کنار گذاشتیم زیرا یکی از اعضای جامعه ما که عمیقاً درگیر ماشین‌آلات منبع باز بود، قرار بود در طول برنامه پایان‌نامه دکتری خود را بنویسد. .) ما در نهایت بیش از اندازه کار داشتیم که سام را مشغول نگه داریم!
- هنگام جستجوی یک نویسنده فنی از شبکه های خود استفاده کنید. از همه افراد جامعه خود برای توصیه بخواهید. اگرچه ما سم را از طریق Google Season of Docs GitHub پیدا کردیم، اما از کار با آنها اطمینان داشتیم زیرا در طول دوره درخواست با چندین نفر صحبت کرده بودیم.
- به نویسنده فنی خود در جامعه خود خوش آمدید! سام به ما اطلاع داد که نگرش مشتاقانه GloriousPicklers باعث شده است که سؤال بپرسیم.
- به نویسنده فنی خود کمک کنید تا مهارت های متن باز را کسب کند. سام قبلاً هرگز از git استفاده نکرده بود، اما پس از گذراندن چند آموزش، آنها به سرعت به سرعت بالا رفتند. در ابتدا سام نگران این بود که چه مقدار بازخورد ممکن است از جامعه دریافت کنند و چگونه آن را بگنجانند، اما مدل «اجماع تقریبی» جامعه ما ( «توافق زمانی حاصل می‌شود که به همه مسائل رسیدگی شود، اما لزوماً رعایت نمی‌شود» ) سم را به این موضوع مطمئن کرد. پرداختن به انتقادات با استفاده از تخصص نگارش فنی آنها.
ضمیمه
اگر مطالب دیگری دارید که می‌خواهید به آنها پیوند دهید (به عنوان مثال، اگر قراردادی برای کار با نویسنده فنی خود ایجاد کرده‌اید که می‌خواهید به اشتراک بگذارید، یا الگوهایی برای پروژه مستندسازی خود یا سایر منابع اسناد باز، می‌توانید لیست کنید و آنها را در اینجا پیوند دهید). ضمیمه همچنین مکان مناسبی برای فهرست کردن پیوندها به هر ابزار اسناد یا منابعی است که استفاده کرده‌اید، یا مکانی برای افزودن تشکر یا قدردانی که ممکن است در بخش‌های بالا مناسب نباشد.
قدردانی
تیم ما مایل است از افراد و موارد زیر قدردانی کند:
- @Dillicious از شریک زندگی خود و همچنین رادیو هیپ هاپ کم فای تشکر می کند
- @KimChiCook از 할머니 خود برای آموزش ترشی کردن به او تشکر می کند.
- @Piccalily می‌خواهد از راهنمای شیکاگو سبک آنلاین تشکر کند
- @GherKen می‌خواهد از سه فرزندش برای خوردن همه ترشی‌هایی که می‌تواند درست کند تشکر کند
- @VinegarViv می‌خواهد از بقیه اعضای تیم برای کناره‌گیری او تشکر کند
- @BBChips از بهترین غذای غیر ترشی موجود، ویفرهای کاراملی Tunnock تشکر می کند.
- @GloriousPicklePat از PickleDocs SIG برای انجام این پروژه تشکر می کند
- سام اسکرایب مایل است از کل جامعه GloriousPickle تشکر کند، به ویژه Picklers که در طول کمبود شیشه تابستان 2021 برای آنها شیشه های کنسرو فرستادند و آنها را در جاده بسیاری از ترشی های خوشمزه شروع کردند!