این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- CERN-HSF
- نویسنده فنی:
- شانس در باران
- نام پروژه:
- گسترش و بهبود مستندات ROOT
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
هدف این پروژه بهبود مستندات ROOT است که سیستم نرم افزاری اصلی برای تجزیه و تحلیل داده ها و ارائه داده ها توسط جامعه فیزیک انرژی بالا در سراسر جهان استفاده می شود.
علاوه بر مهارت‌های نویسنده فنی که می‌توانم برای پروژه ارائه دهم، با ROOT (6 و 7) نیز آشنا هستم و از سایر مؤلفه‌های مورد نیاز پروژه مانند:
- C++
- پایتون
- Git/GitHub
- ابزار ساخت وب سایت (html، markdown، جکیل)
من سه قطعه اصلی را در مستندات ROOT شناسایی می کنم:
- وب سایت https://root.cern،
- راهنمای مرجع کلاس C++ https://root.cern/doc/master/،
- انجمن https://root-forum.cern.ch
به نظر من مستندات ROOT ("راهنمای جدید ROOT") باید در زمینه های زیر بهبود و تکمیل شود:
- این باید برای غیر فیزیکدانان به ویژه فصل های مقدماتی قابل دسترس تر و قابل فهم تر شود.
- آموزش های بیشتری برای توضیح عملکرد کلی ROOT باید توسعه یابد.
- برخی از موضوعات و پیشرفت های جدید باید با توضیحات و مثال های دقیق درج شود. از جمله مواردی که می توانم فهرست کنم:
- اتصال پایتون
- کتابخانه های ریاضی
- توضیحات دستی برای ابزارهای گرافیکی سطح بالا (TRAtioPLot، THStack)
- ابزارهای جدید تجزیه و تحلیل داده کاوی (RDataFrame و RNtuple)
- فرمت های جدید داده های کلیدی (RDataFrame و RNtuple) به مشخصات فنی و آموزش های دقیق نیاز دارند.
پاسخ به سوالات مهم کاربران، مانند مواردی که در انجمن ROOT ارسال شده است، باید در مستندات گنجانده شود. این امر مستلزم تجزیه و تحلیل دقیق سوالات متداول و سپس یک دوره ترکیبی است تا آنها را به قطعات مستند در "راهنمای ROOT" جدید یا در برخی آموزش های جدید در راهنمای مرجع ترجمه کند.
آموزش هایی که عملکردهای ارائه شده توسط ROOT 7 را نشان می دهد.
- هیستوگرام های جدید ROOT 7
- گرافیک جدید ROOT 7
برنامه زمانی تخمینی (5 ماه):
- فاز 1: تعریف وظایف و محدوده برای مستندات و آموزش های ROOT: 2 هفته.
- مرحله 2: جمع آوری و تجزیه و تحلیل سوالات مهم کاربران از انجمن ROOT: 2 هفته
- فاز 3: نوشتن مستندات ROOT: 8 هفته.
- فاز 4: توسعه آموزش: 8 هفته
در نهایت باید اضافه کنم که من قبلاً در سال گذشته با یک پروژه طولانی مدت Google Season of Docs در مستندات ROOT مشارکت داشتم. من ساختار جدید دفترچه راهنما را تعریف کردم. پیشنهاد امسال به تکمیل سایر جنبه‌های مستندسازی که هنوز در ROOT وجود ندارد کمک می‌کند.