فاز فعلی:
توسعه اسناد و مدارک جدول زمانی را ببینید.
Season of Docs یک برنامه پایداری است که توسط دفتر برنامه‌های منبع باز Google مدیریت می‌شود. اهداف Season of Docs عبارتند از:
- ارائه پشتیبانی از پروژه های منبع باز برای حل مشکلات پروژه با مستندات
- به نویسندگان فنی فرصت هایی برای کسب تجربه در متن باز بدهید
- آگاهی از متن باز، اسناد و نگارش فنی را افزایش دهید
- جمع آوری و به اشتراک گذاری اطلاعات در مورد معیارهای موثر در اسناد منبع باز
اطلاعات بیشتر درباره Season of Docs در وب سایت برنامه موجود است.
نمای کلی برنامه 2022
Season of Docs چگونه کار می کند
در Season of Docs، سازمان ها با ارائه پیشنهاد پروژه اقدام می کنند. پیشنهاد پروژه شامل:
- اطلاعات در مورد سازمان
- شرح مشکلی که پروژه با آن مواجه است
- چگونه پروژه از اسناد برای کمک به حل مشکل آنها استفاده خواهد کرد
- چگونه پروژه اثربخشی اسناد آنها را اندازه گیری می کند (متریک ها)
- جدول زمانی برای کار
- بودجه پروژه
- هر گونه اطلاعات اضافی، مانند تجربه سازمان در برنامه های مشابه، یا هر چیز دیگری که به مدیران Season of Docs کمک کند تا پروژه و مشکل خود را درک کنند.
پس از پذیرش در این برنامه، سازمان ها مستقیماً نویسندگان فنی خود را جذب و استخدام می کنند. Season of Docs از Open Collective برای تأمین مالی سازمانها استفاده می‌کند و سازمانها از طریق Open Collective به نویسندگان فنی پرداخت می‌کنند. بودجه و پرداخت های پروژه شفاف است. بودجه‌ها در طرح‌های پروژه سازمانی موجود در سایت Season of Docs گنجانده می‌شوند و پرداخت‌ها در حساب Open Collective Season of Docs قابل مشاهده است.
در نظر گرفته می‌شود که سازمانها با ارائه گزارش مطالعه موردی خود، برنامه را با موفقیت به پایان رسانده‌اند. همچنین از سازمانها خواسته می‌شود که ارزیابی‌های ماهانه را در طول برنامه و سه بررسی سه‌ماهه پیگیری را در طول سال پس از اتمام برنامه تکمیل کنند.
نکات برجسته 2022
"پس از انتشار سند جدید، بازدیدهای روزانه از Casbin و Casdoor تقریبا دو برابر شد و نرخ پرش حدود 30٪ کاهش یافت." - Casbin
«نتیجه لذت بخش این پروژه مشاهده رشد [نویسندگان فنی ما] در نقش های رهبری در جامعه ما بوده است. هر دو شرکت کننده اکنون جلسات گروه کاری و جامعه را رهبری می کنند و همچنین در طراحی و نگهداری پروژه های ما مشارکت می کنند. - moja-global
«[GSoD] به ما کمک کرد تا دو نویسنده فنی با استعداد را به خدمت بگیریم که در یک راه‌اندازی معمولی بسیار دشوار است، که همچنان مشارکت‌کنندگان فعال سیستم‌عامل OpenMined هستند و تجربه کاری خوبی با آنها داشته‌ایم.» - OpenMined
همچنین، کتابچه راهنمای جدید برای مبتدیان طیف سنجی جرمی محاسباتی بسیار آسان تر است. برای نشان دادن این نکته: کمک هزینه CZI همچنین کمک هزینه هایی را برای افراد محروم از لحاظ تاریخی فراهم می کند و برخی از برندگان جوایز از راهنمای جدید OpenMS برای شروع دوره شش هفته ای کارآموزی خود استفاده کرده اند و نظرات مثبتی در مورد کتابچه راهنمای جدید ارائه کرده اند. -OpenMS
داده های خلاصه 2022
در سال 2022، برنامه Season of Docs 31 پروژه از 67 برنامه را پذیرفت و 30 پروژه با موفقیت برنامه را به پایان رساندند. از 31 سازمان پذیرفته شده، 17 سازمان متقاضی مکرر بودند.
31 پروژه پذیرفته شده 58 نویسنده فنی را استخدام کردند. بیش از 190 نویسنده فنی علاقه خود را به شرکت در برنامه با افزودن اطلاعات تماس و پیوندهای خود به نمونه کارها در مخزن Season of Docs GitHub نشان دادند.
برای برنامه 2022:
- 100% سازمان ها تجربه مثبتی از فرآیند درخواست داشتند
- 100% سازمان ها تجربه مثبتی با مستندات/محتوای وب سایت برنامه داشتند
- 93 درصد از سازمان ها تجربه مثبتی از این برنامه داشتند
- 90 درصد از سازمان ها احساس می کردند که پروژه مستندسازی آنها موفق بوده است
درباره سازمان ها
سازمان‌های شرکت‌کننده در Season of Docs 2022 طیف متنوعی از پروژه‌های منبع باز را نمایندگی کردند. گروه 2022 شامل:
- ابزارهای توسعه، مانند AsyncAPI و SpyderIDE
- زبان‌ها و فریمورک‌های برنامه‌نویسی، مانند جولیا ، LFortran ، R و p5.js
- پروژه های علمی، مانند CERN-HSF و SymPy
- برنامه های کاربر نهایی، مانند Mautic ، Open Food Facts ، Talawa و Ushahidi
- پروژه های سخت افزاری و روباتیک، مانند ExpressLRS و Open-RMF
- پروژه های داده مانند GeomScale ، GeomStats ، OpenMined و Weaviate
- پروژه های ابری و زیرساختی، مانند cert-manager ، NimbleEdge و Cilium
ما هیچ ابرداده‌ای درباره پروژه‌ها (مانند تاریخ تأسیس، توزیع جغرافیایی مشارکت‌کنندگان، تعداد مشارکت‌کنندگان یا اندازه پایگاه کاربر) جمع‌آوری نکردیم.
ما از پروژه‌ها خواستیم که نشان دهند از کدام مجوز منبع باز استفاده می‌کنند.
درباره پروژه های مستندسازی
مشکلات مستندسازی
مهمترین مشکلاتی که سازمانها امیدوار بودند با مستندسازی در برنامه 2022 حل کنند عبارتند از:
توجه داشته باشید که سازمان ها می توانند چندین مشکل اسناد را گزارش کنند. برای جزئیات بیشتر، صفحه نتایج Season of Docs 2022 را ببینید که به پیشنهادهای پروژه اصلی و مطالعات موردی کامل برای هر سازمان پیوند دارد.
انواع اسناد ایجاد شده
نحوه مستندسازی متداول‌ترین نوع اسناد ذکر شده در مطالعات موردی 2022 بود.
انواع دیگر اسناد ذکر شده در مطالعات موردی عبارتند از:
- شروع سریع
- واژه نامه
- سوالات متداول
- دانش محور
- اجزاء
- محتوای وبلاگ/رسانه های اجتماعی
- راهنمای نگهدارنده
برخی از این دسته بندی ها فازی هستند و یک پروژه مستندسازی واحد می تواند شامل چندین نوع سند یا ویژگی باشد.
برای جزئیات بیشتر، صفحه نتایج Season of Docs 2022 را ببینید که به پیشنهادهای پروژه اصلی و مطالعات موردی کامل برای هر سازمان پیوند دارد.
بودجه ها
متوسط درخواست بودجه 11679 دلار و میانگین آن 12150 دلار بود. پنج سازمان بالاترین کمک مالی موجود (15 هزار دلار) و سه سازمان کمترین (بین 5 تا 7 هزار دلار) را درخواست کردند و دریافت کردند.
معیارها
پروژه‌ها در مطالعات موردی خود معیارهایی را که برای سنجش موفقیت پروژه‌های مستندسازی خود استفاده می‌کردند، مشخص کردند.
معیارهای پیشنهادی برتر عبارت بودند از:
سایر معیارهای پیشنهادی شامل:
- درخواست‌ها/مشارکت‌های جلب اسناد بیشتر
- بازخورد مستقیم بیشتر در صفحات اسناد
- زمان صرف شده در صفحه
- مشکلات مطرح شده (به عنوان یک پروکسی برای استفاده)
- شرکت کنندگان در انجمن ها
- تعداد شرکا / داوطلبان / ادغام
- کاهش نرخ پرش
- افزایش آگاهی در جامعه.
به دلیل فاصله کوتاه بین تکمیل پروژه‌های نگارش فنی و ارائه مطالعات موردی، اکثر گروه‌های سال 2022 نتوانستند داده‌های کافی را در زمان ارائه مطالعات موردی خود جمع‌آوری کنند تا تعیین کنند که آیا معیارهای اولیه آنها برآورده شده است یا خیر.
از آنجایی که در سال 2023 پاسخ‌های نظرسنجی‌های بعدی را دریافت می‌کنیم، این گزارش را به‌روزرسانی می‌کنیم تا اطلاعاتی درباره پروژه‌هایی که به معیارهای خود دست یافته‌اند یا معیارهای خود را اصلاح کرده‌اند، اضافه کنیم.
برای جزئیات بیشتر، صفحه نتایج Season of Docs 2022 را ببینید که به پیشنهادهای پروژه اصلی و مطالعات موردی کامل برای هر سازمان پیوند دارد.
کار با نویسندگان فنی
در برنامه Season of Docs، از پروژه‌ها انتظار می‌رود که مستقیماً از نویسندگان فنی استخدام، مصاحبه، استخدام و پرداخت کنند. نویسنده‌های فنی می‌توانند خود را به فهرستی که Season of Docs در مخزن GitHub ما نگهداری می‌کند اضافه کنند، اما کارکنان Season of Docs نویسندگان فنی را بررسی نمی‌کنند یا توصیه نمی‌کنند.
بهترین روش ها برای استخدام نویسندگان فنی برای پروژه های منبع باز
از پروژه ها خواسته شد تا بهترین شیوه های خود را برای استخدام، استخدام و کار با نویسندگان فنی به اشتراک بگذارند. توصیه های برتر عبارت بودند از:
استخدام
- با نامزدهای کمتری مصاحبه کنید و به جای بررسی رزومه، از یک جلسه تمرین زنده استفاده کنید
- به مهارت‌های ارتباطی نوشتاری و شفاهی بیش از مهارت در زبان یا ابزار پروژه خود اهمیت دهید
- سؤالات مستقیمی در مورد اینکه نویسنده فنی چگونه دانش دامنه لازم را برای کار با پروژه شما به دست می آورد، بپرسید
- فردی که مشتاق ماموریت پروژه شما است و ارزش های منبع باز اصلی را به اشتراک می گذارد، به احتمال زیاد در کل پروژه با انگیزه باقی می ماند.
- پذیرای متقاضیان از سراسر جهان باشید، زیرا دیدگاه‌ها و پیشینه‌های گوناگون به پروژه شما کمک می‌کند - اما توجه داشته باشید که داشتن نویسندگان و مربیان در مناطق زمانی بسیار متناقض ممکن است به تلاش زیادی برای حفظ ارتباط خوب نیاز داشته باشد.
استخدام
- از قراردادی استفاده کنید که محصولات تحویلی، برنامه‌های پرداخت و تعهدات زمانی خاص را به وضوح بیان کند
- اگر پروژه شما ناشناخته های زیادی دارد، یک نقطه عطف برای کشف یا تحقیق جدا از ایجاد مستندات قرار دهید
هماهنگی و ارتباط
- یک گزارش جلسه برای ضبط تصمیمات نگه دارید تا درک زمینه و مراحل بعدی برای همه افرادی که روی پروژه کار می کنند آسان تر شود
- در مورد اینکه چه ارتباطی انتظار می‌رود و چند وقت یکبار، چه تماس‌های هفتگی، ایمیل‌های روزانه یا به‌روزرسانی وضعیت در یک کانال چت، شفاف باشید.
- پاسخگو باشید و بازخورد واضحی ارائه دهید که شامل «چرا» است و نه فقط «چی»
- نویسندگان فنی خود را با جامعه گسترده‌تر ارتباط دهید تا زمینه را به آنها بدهید و کارشان را اجتماعی کنید
فرآیندها و ابزار
- یک فرآیند مستندسازی ایجاد کنید که فراتر از برنامه Season of Docs ادامه داشته باشد و کل جامعه بتواند در آن مشارکت داشته باشد
- بررسی اسناد حداقل به همان اندازه طول می کشد و به اندازه بررسی کد فشرده است. مطمئن شوید که زمان کافی برای آن در نظر گرفته اید
برخی از توصیه ها برای وضوح ویرایش و فشرده شده اند.
مانند برنامه 2021، اکثر نویسندگان فنی در Season of Docs 2022 مستقیماً به سازمان هایی که با آنها کار می کردند درخواست دادند.
مسائل رایج در کار با نویسندگان فنی
پروژه های کمتری مشکلاتی را در کار با نویسندگان فنی خود در برنامه 2022 گزارش کردند. ناتوانی نویسندگان فنی به دلیل بیماری، گرفتن یک شغل تمام وقت یا ناتوانی در انجام تعهد زمانی، بزرگترین مشکل بود.
یکی از پروژه‌ها گزارش داد که پروژه مستندسازی آنها وابسته به کاری است که به عنوان بخشی از Google Summer of Code انجام می‌شود و مدیریت آن وابستگی‌ها دشوار است. پروژه دیگری با مشکلاتی روبرو شد که سخت افزار مورد نیاز نویسنده فنی آنها توسط وزارت دفاع در کشور نویسنده مصادره شد و قابل واردات نبود.
بررسی های پیگیری
سه نظرسنجی بعدی برای شرکت کنندگان 2022 در ماه مه، آگوست و نوامبر 2023 ارسال می شود. ما این بخش را با نتایج به محض دریافت به روز می کنیم.
سوالات آینده
مثل همیشه، هر چه بیشتر در مورد مستندات در متن باز یاد بگیریم، بیشتر می خواهیم بیاموزیم!
در فصل های آینده امیدواریم:
- ابرداده های پروژه بیشتری را جمع آوری کنید تا به دنبال همبستگی بین سن پروژه، اندازه جامعه، یا نیازهای زبان و اسناد باشید.
- پروژه های مستندسازی را تجزیه و تحلیل کنید تا ببینید آیا می توان آنها را به قالب های قابل اشتراک گذاری تعمیم داد
- یک روبریک برای مصاحبه با نویسندگان فنی در پروژه های متن باز ایجاد کنید
اگرچه سؤالات زیادی وجود دارد که مایلیم بررسی کنیم، اما همچنین می‌خواهیم به زمان مدیران و نگهبانان پروژه منبع باز که در Season of Docs شرکت می‌کنند احترام بگذاریم. اولویت اصلی برنامه حمایت از پروژه ها در حل مشکلات آنها با مستندسازی است.