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 شرکت می‌کنند احترام بگذاریم. اولویت اصلی برنامه حمایت از پروژه ها در حل مشکلات آنها با مستندسازی است.
،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 شرکت می‌کنند احترام بگذاریم. اولویت اصلی برنامه حمایت از پروژه ها در حل مشکلات آنها با مستندسازی است.
،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 Docs باشد و کل جامعه می تواند در آن نقش داشته باشد
- بررسی مستندات حداقل به اندازه طولانی طول خواهد کشید و به همان اندازه بررسی کد فشرده است. اطمینان حاصل کنید که وقت کافی برای آن اجازه می دهید
برخی از توصیه ها برای وضوح ویرایش و متراکم شده اند.
همانطور که در برنامه 2021 ، بیشتر نویسندگان فنی در فصل Docs 2022 مستقیماً در سازمانهایی که با آنها کار کرده اند اعمال می شود.
موضوعات مشترک در کار با نویسندگان فنی
تعداد کمتری از پروژه ها در برنامه 2022 با کار با نویسندگان فنی خود کار می کنند. نویسندگان فنی که قادر به تکمیل برنامه نیستند ، به دلیل بیماری ، گرفتن شغل تمام وقت یا عدم توانایی در انجام تعهد زمانی ، بزرگترین مسئله بود.
یک پروژه گزارش داد که پروژه مستندات آنها به کارهایی که به عنوان بخشی از Google Summer of Code انجام می شود بستگی دارد و مدیریت این وابستگی ها دشوار است. هنگامی که سخت افزار نویسنده فنی آنها برای مستند سازی نیاز به مصادره داشت ، توسط وزارت دفاع در کشور نویسنده مصادره شد و وارد آن شد.
بررسی های پیگیری
سه نظرسنجی پیگیری به شرکت کنندگان 2022 در ماه مه ، آگوست و نوامبر 2023 ارسال می شود. ما این بخش را با نتایج دریافت می کنیم.
سوالات آینده
مثل همیشه ، هرچه بیشتر در مورد مستندات در منبع آزاد بیاموزیم ، بیشتر می خواهیم یاد بگیریم!
در فصول آینده امیدواریم:
- برای جستجوی همبستگی بین سن پروژه ، اندازه جامعه یا نیازهای زبان و مستندات بیشتر ، ابرداده پروژه بیشتری را جمع آوری کنید
- پروژه های مستندات را تجزیه و تحلیل کنید تا ببینید که آیا می توان آنها را در الگوهای مشترک تعمیم داد
- برای مصاحبه با نویسندگان فنی در پروژه های منبع باز ، یک موضوع ایجاد کنید
اگرچه سؤالات بسیاری وجود دارد که ما می خواهیم تحقیق کنیم ، اما ما همچنین می خواهیم به زمان سرپرستان و نگهبانان پروژه منبع باز که در فصل اسناد شرکت می کنند ، احترام بگذاریم. اولویت اصلی این برنامه حمایت از پروژه ها در حل مشکلات آنها با مستندات است.
،Season of Docs یک برنامه پایداری است که توسط دفتر برنامه های منبع باز Google اداره می شود. اهداف فصل اسناد به این موارد است:
- برای حل مشکلات پروژه با مستندات پشتیبانی از پروژه های منبع باز ارائه دهید
- به نویسندگان فنی فرصت دهید تا در منبع باز تجربه کسب کنند
- افزایش آگاهی از منبع باز ، مستندات و نوشتن فنی
- اطلاعات مربوط به معیارهای مؤثر را در مستندات منبع باز جمع آوری و به اشتراک بگذارید
اطلاعات بیشتر در مورد Season of Docs در وب سایت برنامه موجود است.
نمای کلی برنامه 2022
چگونه فصل Docs کار می کند
در فصل اسناد ، سازمان ها با ارسال یک پیشنهاد پروژه اعمال می شوند. پیشنهاد پروژه شامل:
- اطلاعات مربوط به سازمان
- توضیحی از مشکلی که پروژه با آن روبرو است
- چگونه این پروژه از مستندات برای کمک به حل مشکل آنها استفاده خواهد کرد
- چگونه این پروژه اثربخشی مستندات آنها را اندازه گیری می کند (معیارها)
- یک جدول زمانی برای کار
- بودجه پروژه
- هرگونه اطلاعات اضافی ، مانند تجربه سازمان در برنامه های مشابه یا هر چیز دیگری که به فصل مدیران Docs کمک کند تا پروژه و مشکل خود را درک کنند
پس از پذیرفتن این برنامه ، سازمان ها نویسندگان فنی خود را مستقیماً استخدام و استخدام می کنند. فصل Docs از مجموعه آزاد برای تأمین بودجه سازمان ها استفاده می کند و سازمان ها به نویسندگان فنی از طریق Open Collective پرداخت می کنند. بودجه پروژه و پرداخت شفاف است. بودجه ها در پیشنهادات پروژه سازمان موجود در سایت Season Docs گنجانده شده است و پرداخت ها در فصل حساب Collective Open Docs قابل مشاهده است.
در نظر گرفته می شود که سازمان ها هنگام ارسال گزارش مطالعه موردی خود ، برنامه را با موفقیت انجام داده اند. همچنین از سازمان ها خواسته می شود ارزیابی های ماهانه را در طول برنامه و سه بررسی پیگیری سه ماهه در طول سال پس از اتمام برنامه انجام دهند.
نکات برجسته 2022
"پس از انتشار سند جدید ، بازدید روزانه از Casbin و Casdoor تقریباً دو برابر شد و نرخ گزاف گویی حدود 30 ٪ کاهش یافت." - Casbin
"نتیجه لذت بخش این پروژه تماشای [نویسندگان فنی ما] در جامعه ما به نقش های رهبری تبدیل شده است. هر دو مشارکت کننده اکنون جلسات کارگروه و جامعه را رهبری می کنند و همچنین در طراحی و نگهداری پروژه های ما نقش دارند." ‘موجا-گلوبال
"[GSOD] به ما کمک کرد تا دو نویسنده فنی با استعدادی را استخدام کنیم که در یک مجموعه منظم بسیار دشوار است ، که همچنان به عنوان مشارکت کننده سیستم عامل برای OpenMined و با آنها تجربه کاری خوبی داشته ایم." - باز شده
"همچنین ، کتابچه راهنمای جدید برای طیف سنجی جرمی محاسباتی بسیار ساده تر است. برای نشان دادن این نکته: کمک هزینه CZI همچنین برای افراد محروم تاریخی کمک هزینه هایی را ارائه می دهد و برخی از جوایز از کتابچه راهنمای جدید OpenMS برای پرش دوره کارآموزی شش هفته خود استفاده کرده اند و بررسی های مثبتی از کتابچه راهنمای جدید ارائه داده اند." ‘OpenMs
2022 داده های خلاصه
در سال 2022 ، برنامه Season Docs 31 پروژه از 67 برنامه را پذیرفت و 30 پروژه با موفقیت برنامه را به پایان رساندند. از 31 سازمان پذیرفته شده ، 17 سازمان متقاضی تکرار شدند.
31 پروژه پذیرفته شده 58 نویسنده فنی را استخدام کردند. بیش از 190 نویسنده فنی با افزودن اطلاعات تماس و پیوندهای خود به پرتفوی خود در فصل Docs Github Repo ، علاقه خود را به شرکت در این برنامه نشان دادند.
برای برنامه 2022:
- 100 ٪ سازمانها تجربه مثبتی در روند درخواست داشتند
- 100 ٪ سازمانها تجربه مثبتی با مستندات/محتوا وب سایت برنامه داشتند
- 93 ٪ سازمان ها تجربه مثبتی با برنامه داشتند
- 90 ٪ سازمان ها احساس کردند که پروژه مستندات آنها موفقیت آمیز بوده است
درباره سازمانها
سازمان های شرکت کننده در فصل Docs 2022 ، طیف متنوعی از پروژه های منبع باز را نشان می دهند. گروه 2022 شامل:
- ابزارهای توسعه ، مانند asyncapi و spyderide
- زبان ها و چارچوب های برنامه نویسی ، مانند جولیا ، لوررتران ، R و P5.JS
- پروژه های علمی ، مانند CERN-HSF و SYMPY
- برنامه های کاربردی کاربر نهایی ، مانند مائوتیک ، حقایق غذایی باز ، تالوا و اوشهیدی
- پروژه های سخت افزار و روباتیک ، مانند Expresslrs و Open-RMF
- پروژه های داده ، مانند Geomscale ، Geomstats ، OpenMined و Weaviate
- پروژه های ابر و زیرساختی ، مانند Manager ، Nimbleedge و Cilium
ما هیچ ابرداده ای در مورد پروژه ها (مانند تاریخ تأسیس ، توزیع جغرافیایی مشارکت کنندگان ، تعداد مشارکت کنندگان یا اندازه پایگاه کاربر) جمع آوری نکردیم.
ما از پروژه ها خواسته ایم تا نشان دهیم که از چه مجوز منبع باز استفاده کرده اند.
درباره پروژه های مستندات
مشکلات مستند سازی
مهمترین مشکلاتی که سازمانها امیدوار بودند با اسناد و مدارک در برنامه 2022 حل کنند شامل موارد زیر است:
توجه داشته باشید که سازمان ها می توانند چندین مشکل مستندات را گزارش دهند. برای مشخصات بیشتر ، به صفحه نتایج Docs 2022 مراجعه کنید ، که به پیشنهادات اصلی پروژه و مطالعات کامل موردی برای هر سازمان پیوند دارد.
انواع مستندات ایجاد شده
چگونه مستندات متداول ترین نوع مستندات ذکر شده در مطالعات موردی 2022 بود.
سایر انواع مستندات ذکر شده در مطالعات موردی شامل:
- شروع سریع
- واژه نامه
- سوالات متداول
- پایگاه دانش
- اجزاء
- محتوای وبلاگ/رسانه های اجتماعی
- راهنمای نگهدارنده
برخی از این دسته ها فازی هستند و یک پروژه مستند سازی واحد می تواند شامل انواع یا ویژگی های مستندات متعدد باشد.
برای مشخصات بیشتر ، به صفحه نتایج Docs 2022 مراجعه کنید ، که به پیشنهادات اصلی پروژه و مطالعات کامل موردی برای هر سازمان پیوند دارد.
بودجه ها
متوسط درخواست بودجه 11،679 دلار و میانگین 12150 دلار بود. پنج سازمان درخواست کردند و بالاترین کمک هزینه موجود (15K دلار) را دریافت کردند و سه مورد کمترین درخواست (بین 5K-7K $) را دریافت کردند.
معیارها
پروژه هایی که در مطالعات موردی آنها معیارهایی که از آنها استفاده می کردند برای سنجش موفقیت پروژه های مستندات خود بیان شده اند.
معیارهای پیشنهادی برتر عبارت بودند از:
سایر معیارهای پیشنهادی شامل:
- مستندات بیشتر درخواست ها/مشارکت ها
- بازخورد مستقیم بیشتر در صفحات مستندات
- زمان صرف شده در صفحه
- موضوعات مطرح شده (به عنوان یک پروکسی برای استفاده)
- شرکت کنندگان در انجمن ها
- تعداد شرکا/داوطلبان/ادغام
- کاهش نرخ گزاف گویی
- افزایش آگاهی در جامعه.
به دلیل پنجره کوتاه بین اتمام پروژه های نوشتن فنی و ارائه مطالعات موردی ، بیشتر گروه 2022 نتوانسته اند در زمان ارسال مطالعات موردی خود داده های کافی را جمع آوری کنند تا مشخص کنند که آیا معیارهای اولیه آنها برآورده شده است یا خیر.
از آنجا که ما در سال 2023 پاسخ به نظرسنجی های پیگیری دریافت می کنیم ، این گزارش را به روز می کنیم تا اطلاعاتی در مورد اینکه کدام پروژه ها به معیارهای خود دست یافته اند یا معیارهای آنها را تجدید نظر کرده اند ، اضافه کنیم.
برای مشخصات بیشتر ، به صفحه نتایج Docs 2022 مراجعه کنید ، که به پیشنهادات اصلی پروژه و مطالعات کامل موردی برای هر سازمان پیوند دارد.
کار با نویسندگان فنی
در فصل برنامه Docs ، انتظار می رود پروژه ها به طور مستقیم به نویسندگان فنی استخدام ، مصاحبه ، استخدام و پرداخت کنند. نویسندگان فنی می توانند خود را به دایرکتوری که در فصل اسناد در مخزن GitHub ما نگهداری می شود ، اضافه کنند ، اما فصل کارکنان Docs نویسندگان فنی را دامپزشک یا توصیه نمی کنند.
بهترین روشها برای استخدام نویسندگان فنی برای پروژه های منبع باز
از پروژه ها خواسته شد تا بهترین شیوه های خود را برای استخدام ، استخدام و کار با نویسندگان فنی به اشتراک بگذارند. توصیه های برتر این بود:
استخدام کردن
- با نامزدهای کمتری مصاحبه کنید ، و به جای بررسی CVS ، از یک جلسه تمرین زنده استفاده کنید
- مهارت های ارتباطی کتبی و شفاهی را بیش از مهارت در زبان یا ابزار پروژه خود ارزیابی کنید
- سؤال مستقیم در مورد چگونگی دستیابی به نویسنده فنی هرگونه دانش دامنه لازم برای کار با پروژه خود بپرسید
- شخصی با اشتیاق به مأموریت پروژه شما و به اشتراک گذاشتن ارزش های اصلی منبع باز ، بیشتر از این پروژه انگیزه دارد
- برای متقاضیان از سراسر جهان باز باشید ، زیرا تنوع دیدگاه ها و پیشینه ها به پروژه شما کمک می کند - اما توجه داشته باشید که داشتن نویسندگان و مربیان در بسیاری از مناطق متضاد متضاد ممکن است برای حفظ ارتباطات خوب نیاز به تلاش اضافی داشته باشد
استخدام
- از قراردادی استفاده کنید که به وضوح تحویل ، برنامه پرداخت و تعهدات زمانی خاص را بیان می کند
- اگر پروژه شما ناشناخته های زیادی دارد ، شامل نقطه عطفی برای کشف یا تحقیقات جدا از ایجاد مستندات است
هماهنگی و ارتباطات
- تصمیم گیری در مورد ضبط ورود به سیستم را حفظ کنید تا همه افراد کار در این پروژه را برای درک زمینه و مراحل بعدی آسان تر کنید
- در مورد اینکه چه ارتباطی انتظار می رود و چند بار ، چه تماس های هفتگی ، ایمیل های روزانه یا به روزرسانی وضعیت در یک کانال چت ، واضح باشید
- پاسخگو باشید و بازخورد واضحی ارائه دهید که شامل "چرا" و نه فقط "چه چیزی" است
- نویسندگان فنی خود را با جامعه وسیع تر وصل کنید تا به آنها زمینه و معاشرت کار خود را به آنها بدهید
فرآیندها و ابزار
- یک فرایند مستند سازی ایجاد کنید که فراتر از برنامه Season Docs باشد و کل جامعه می تواند در آن نقش داشته باشد
- بررسی مستندات حداقل به اندازه طولانی طول خواهد کشید و به همان اندازه بررسی کد فشرده است. اطمینان حاصل کنید که وقت کافی برای آن اجازه می دهید
برخی از توصیه ها برای وضوح ویرایش و متراکم شده اند.
همانطور که در برنامه 2021 ، بیشتر نویسندگان فنی در فصل Docs 2022 مستقیماً در سازمانهایی که با آنها کار کرده اند اعمال می شود.
موضوعات مشترک در کار با نویسندگان فنی
تعداد کمتری از پروژه ها در برنامه 2022 با کار با نویسندگان فنی خود کار می کنند. نویسندگان فنی که قادر به تکمیل برنامه نیستند ، به دلیل بیماری ، گرفتن شغل تمام وقت یا عدم توانایی در انجام تعهد زمانی ، بزرگترین مسئله بود.
یک پروژه گزارش داد که پروژه مستندات آنها به کارهایی که به عنوان بخشی از Google Summer of Code انجام می شود بستگی دارد و مدیریت این وابستگی ها دشوار است. هنگامی که سخت افزار نویسنده فنی آنها برای مستند سازی نیاز به مصادره داشت ، توسط وزارت دفاع در کشور نویسنده مصادره شد و وارد آن شد.
بررسی های پیگیری
سه نظرسنجی پیگیری به شرکت کنندگان 2022 در ماه مه ، آگوست و نوامبر 2023 ارسال می شود. ما این بخش را با نتایج دریافت می کنیم.
سوالات آینده
مثل همیشه ، هرچه بیشتر در مورد مستندات در منبع آزاد بیاموزیم ، بیشتر می خواهیم یاد بگیریم!
در فصول آینده امیدواریم:
- برای جستجوی همبستگی بین سن پروژه ، اندازه جامعه یا نیازهای زبان و مستندات بیشتر ، ابرداده پروژه بیشتری را جمع آوری کنید
- پروژه های مستندات را تجزیه و تحلیل کنید تا ببینید که آیا می توان آنها را در الگوهای مشترک تعمیم داد
- برای مصاحبه با نویسندگان فنی در پروژه های منبع باز ، یک موضوع ایجاد کنید
اگرچه سؤالات بسیاری وجود دارد که ما می خواهیم تحقیق کنیم ، اما ما همچنین می خواهیم به زمان سرپرستان و نگهبانان پروژه منبع باز که در فصل اسناد شرکت می کنند ، احترام بگذاریم. اولویت اصلی این برنامه حمایت از پروژه ها در حل مشکلات آنها با مستندات است.