این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- CERN-HSF
- نویسنده فنی:
- جان
- نام پروژه:
- CERN-HSF - مستندات ریشه برای پذیرش مخاطبان عمومی، پیوندهای پویا پایتون، و آموزش‌ها
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
CERN-HSF - ROOT Documentation for Audience General Adoption، Dynamic Python Bindings and Tutorials مربی: Olivier Couet, Axel Naumann
چکیده: مستندسازی برای پذیرش موفق و کارآمد نرم افزار توسط کاربران ضروری است. مستندات واضح، دقیق و جامع کاربر، مهارت کاربران را با نرم افزار در راستای اهداف خود تسهیل می کند. در امتداد این خطوط، مثال‌ها و آموزش‌های صریح به عنوان ابزار قدرتمندی عمل می‌کنند که کاربران می‌توانند به سرعت یاد بگیرند.
همانطور که ما استفاده از ROOT توسط فیزیکدانان، محققان و توسعه دهندگان را در فضای تجزیه و تحلیل داده ها و تجسم برای فیزیک بررسی می کنیم، مزایای اسناد کاربرپسند و به روز شده به رسمیت شناخته می شود. به طور خاص، با توجه به گستردگی کد منبع و رشد آن، سیستم مستندسازی از پیشرفت موازی بهره می برد تا به کاربران این امکان را بدهد که تمام آنچه ROOT ارائه می دهد را به حداکثر برسانند.
خلاصه و تجزیه و تحلیل اسناد فعلی در حال حاضر، مستندات کاربر راهنمائی ارائه می‌دهد که به فیزیکدانان اجازه می‌دهد تا نسبت به مخاطبان عمومی راحت‌تر ROOT را اتخاذ کنند. علاوه بر این، در موضوعات خاصی مانند Dynamic Python Bindings، می‌توان برای مستندات جامع‌تر و واضح‌تر بهبودهایی ایجاد کرد. به طور مشابه، فرمت داده جدید RNTuple فاقد مشخصات دقیق لازم است. در نهایت، مستندات فعلی فاقد آموزش های مربوط به ROOT 7 هستند.
روش‌شناسی: پس از گفتگو با اولیویه، به نظر می‌رسد که برای پرداختن به موضوعات فوق، تمرکز اولیه باید شامل شناسایی شکاف‌های دانش بین محققان تخصصی و مخاطبان عام، ایجاد مستنداتی برای پر کردن آن شکاف، نوشتن مستندات دقیق‌تر از Dynamic Python Bindings باشد. ، پیاده سازی "آموزش های تحلیل مدرن" برای ROOT 7 و ایجاد مشخصات فنی دقیق برای RNTuple. در طول این فرآیند، مستندات می توانند نوت بوک های Jupyter را در خود جای دهند تا ابزارهای یادگیری ملموس و تعاملی بتوانند به کاربران کمک کنند.
جدول زمانی: مراحل پروژه به این صورت تخمین زده می شود: شناسایی شکاف های دانش بین محققان تخصصی و مخاطبان عمومی (در حین مطالعه اسناد و کد منبع فعلی) → 1-2 هفته ایجاد و بازسازی اسناد برای پر کردن این شکاف → 3 هفته نوشتن مستندات دقیق تر Dynamic Python Bindings → 3 هفته آموزش پیاده سازی برای Dynamic Python Bindings → 3 هفته آموزش پیاده سازی برای ROOT 7 → 4 هفته ایجاد مشخصات فنی دقیق برای RNTuple → 3 هفته بررسی اهداف پروژه با موفقیت به پایان رسید → 1 هفته
محصولات تحویلی و راهنمای موفقیت: مستندات کاربر یکپارچه بدون هیچ شکافی مستندات کاربر کاملاً به روز شده برای منعکس کردن جدیدترین ویژگی ها، به عنوان مثال کلاس های مشتق شده جدید آموزش ها از طریق نوت بوک های Jupyter