این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- DIPY
- نویسنده فنی:
- عریشه طارق
- نام پروژه:
- تجدید ساختار در سطح بالا و تمرکز بر کاربر نهایی
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
من مهندس نرم افزار هستم و در نوشتن فنی تخصص دارم. من بیش از 4 سال تجربه در نوشتن اسناد نرم افزاری با کیفیت بالا، راهنمای کاربر، کتابچه راهنمای کاربر، توضیحات پروژه دارم. من در اسلام آباد، پاکستان زندگی می کنم (منطقه زمانی: UTC + 5). در حال حاضر به عنوان کارآموز در Outreachy مشغول به کار هستم که تا 18 آگوست ادامه خواهد داشت. من در Google Season of Docs به عنوان یک نویسنده فنی در سازمان OpenELIS Global شرکت کردم. مستندات اصلی به زبان فرانسوی، محدود و قدیمی بود، بنابراین من یک مستند کاربر نهایی گسترده و به روز به زبان انگلیسی ایجاد کردم. من در Outreachy در سازمان Perl & Raku برای دور ماه مه تا آگوست 2020 به عنوان توسعه دهنده سرور Open Food Facts انتخاب شدم. علاوه بر توسعه back-end، یکی از وظایف اصلی این کارآموزی ایجاد مستندات برای ماژول ها و توابع در قالب POD است. من سال گذشته زمانی که در چند پروژه منبع باز مشارکت کردم و بعداً در فصل اسناد Google شرکت کردم، وارد دنیای متن باز شدم. و امسال، من در Outreachy انتخاب شدم که از تنوع در منبع باز و نرم افزار رایگان پشتیبانی می کند. از آنجایی که پروژه Outreachy من در GitHub میزبانی می شود، به Git تسلط دارم و از ماه مارس به طور منظم در Open Food Facts و Mozilla Fenix مشارکت داشته ام. من یک کاربر لینوکس برای بیش از 3 سال گذشته هستم و از آن زمان از دستورات ترمینال استفاده می کنم.
ابزارها و زبان‌های مستندسازی که من استفاده کرده‌ام عبارتند از Sphinx، Read the Docs، Markdown. من این ایده را دوست داشتم و می خواهم روی آن کار کنم زیرا تجربه مرتبط دارم و دوست دارم از دانش و مهارت هایم برای کمک به DIPY استفاده کنم. من در زمینه پردازش تصویر دیجیتال، بینایی کامپیوتر، یادگیری ماشین تجربه دارم. این به من در درک بهتر تصویربرداری عصبی و ایجاد مستندات کمک می کند. من تجربه زیادی در زمینه پزشکی دارم. من یک وب سایت پزشکی برای پزشکان، بیماران، آزمایشگاه ها، رانندگان آمبولانس ایجاد کردم. من روی سیستم دیگری کار کردم که توسط پزشکان، بیماران، پرستاران، دستیاران آزمایشگاه و محققان استفاده می‌شود. این به من در ایجاد مستنداتی کمک می کند که درک آن برای مخاطب آسان تر باشد.
من مستندات DIPY را بررسی کرده ام و چندین نقص را در مستندات ذکر کرده ام. چندین حفره در اسناد وجود دارد که من قصد دارم آنها را بهبود ببخشم. وضعیت فعلی مستندات: مستندات فاقد ساختار و طراحی خاص هستند. پیمایش برای کاربران جدید می تواند خسته کننده و وقت گیر باشد. یک کاربر جدید، دسترسی به راهنمای کاربر و راهنمای توسعه دهنده برای من سخت بود. اسناد باید به گونه ای تغییر شکل دهند که اطلاعات مورد نیاز کاربر به راحتی قابل دسترسی باشد.
من قصد دارم کارهای زیر را انجام دهم:
تعریف یک ساختار و الگوی خاص برای مستندات. شکل اسناد را به گونه‌ای تغییر دهید که کاربران بتوانند به راحتی اطلاعات مورد نیاز را پیمایش کنند و اطلاعات مورد نیاز را پیدا کنند. ایجاد نقشه راه یا فهرستی از موارد کاری برای مشارکت دادن جامعه در کارهای مستندسازی بیشتر تعریف قالب‌هایی برای راهنمای کاربر و راهنمای توسعه‌دهنده تعریف کنید. الگوهایی برای کمک به راهنما بازنویسی، بازسازی و به روز رسانی راهنمای کاربر، راهنمای توسعه و راهنمای مشارکتی (که می تواند به کاربران جدید کمک کند و انگیزه آنها برای مشارکت در پروژه باشد) افزودن تصاویر غیر متنی برای بهبود توضیحات متنی بهبود ثبات در اسناد ایجاد مستندات برای رابط خط فرمان جدید
راهنمای کاربر:
برای راهنمای کاربر، من بر استفاده از زبان ساده و ساده تمرکز می کنم تا به کاربران کمک کنم حتی پیچیده ترین سیستم ها را درک کنند. اصطلاحات، کلمات اختصاری و سایر اطلاعات داخلی که ممکن است یک کاربر جدید نداند برای تجربه کاربری بهتر اجتناب شود. همچنین بر استفاده از محتوای بصری، از جمله تصاویر، اسکرین شات های حاشیه نویسی شده، گرافیک ها و ویدئوها تمرکز خواهم کرد که به سرعت نحوه عملکرد سیستم را به کاربر نشان می دهد. مستندات خوب نیاز به سلسله مراتبی از سرفصل‌ها و عنوان‌های فرعی دارد که به کاربر اجازه می‌دهد بداند هر بخش چه چیزی را به آنها نشان می‌دهد. و این سلسله مراتب باید از یک جریان منطقی پیروی کند که به کاربر کمک کند یاد بگیرد که از سیستم به بهترین شکل استفاده کند. یکی از اهداف اصلی این پروژه ایجاد محتوای قابل دسترس خواهد بود. همه اسناد و راهنماها از یک سبک ثابت پیروی می کنند. استفاده از فونت های ثابت و رنگ های مکمل در چندین سند ضروری است. من مطمئن خواهم شد که کاربران به منابع بیشتری از سازمان در مورد چگونگی موفقیت در سیستم دسترسی دارند.
راهنمای توسعه دهنده:
راهنمای توسعه دهنده شامل راهنمایی و مطالب مرجع گسترده ای است که به توسعه دهنده در ایجاد مشارکت در کد منبع DIPY کمک می کند. سعی می‌کند گزینه‌های مختلفی را که برای شما در دسترس است ارائه کند، بنابراین بسته به آنچه می‌خواهید به دست آورید، بتوانید از رویکرد درست استفاده کنید. راهنمای توسعه نیاز به تغییر شکل و ساختار دارد. من محتوای راهنمای توسعه دهنده را بازنویسی خواهم کرد. وابستگی‌های ساختمان، راهنمای کمک‌کننده، راهنمای سبک، قراردادهای کدگذاری، راهنمای مستندسازی، نصب محیط توسعه، اشکال‌زدایی، راهنمای آزمایش و موارد مرتبط گنجانده شده و به راحتی در دسترس توسعه‌دهندگان قرار می‌گیرد. وقتی مشارکت‌کنندگان جدید مشتاق به پروژه شما می‌روند تا اولین مشارکت منبع باز خود را انجام دهند، به دستورالعمل‌های مشارکت‌کننده تکیه می‌کنند تا راهنمای آنها باشد. بنابراین خواندن دستورالعمل ها آسان، کامل و دوستانه خواهد بود. راهنماهای کمکی اسناد مفیدی هستند که نحوه مشارکت افراد را در پروژه منبع باز نشان می دهند. مشارکت در پروژه باید تا حد امکان آسان و شفاف برای کاربران باشد، خواه این باشد: ارسال یک رفع اشکال گزارش یک اشکال تبدیل شدن به یک نگهدار بحث در مورد وضعیت فعلی کد پیشنهاد ویژگی های جدید
الگو
این یکی از الگوهایی است که می تواند برای راهنمای مشارکت استفاده شود. می توان آن را تغییر داد و بخش هایی را می توان با توجه به الزامات سند اضافه یا حذف کرد.
کمک به DIPY
- یادداشت خوش آمدید
TOC
کد رفتار
- استانداردهای ما
- نمونه هایی از رفتارهایی که به ایجاد یک محیط مثبت کمک می کنند
- نمونه هایی از رفتار غیرقابل قبول شرکت کنندگان
- مسئولیت های ما
- مسئولیت های نگهبانان پروژه
- دامنه
محدوده آیین نامه رفتار
برای کمک به چه چیزی باید بدانم؟
اگر به دنبال کمک به کمک کدی هستید که پروژه ما از آن استفاده می‌کند [لیست زبان‌های برنامه‌نویسی، چارچوب‌ها، یا ابزارهایی که پروژه شما استفاده می‌کند را وارد کنید]. اگر هنوز برای مشارکت در کد آماده نیستید، مشکلی نیست! همچنین می‌توانید مشکلات مستندات [پیوند به برچسب اسناد یا برچسب روی ردیاب مشکل شما] یا مشکلات طراحی را که ما داریم [پیوند به برچسب طراحی یا برچسب روی ردیاب مشکل اگر پروژه شما مشکلات طراحی را دنبال می‌کند] بررسی کنید. اگر شما علاقه مند به مشارکت در کد هستید و می خواهید در مورد فناوری هایی که ما استفاده می کنیم بیشتر بدانید، لیست زیر را بررسی کنید. فهرست گلوله‌ای از منابع (آموزش‌ها، فیلم‌ها، کتاب‌ها) را درج کنید که مشارکت‌کنندگان جدید می‌توانند از آنها برای یادگیری آنچه کاربران برای مشارکت در پروژه باید بدانند استفاده کنند.
راه اندازی محیط توسعه
در این بخش، مراحل نصب و وابستگی هایی که باید نصب شوند را اضافه می کنم. با اجرای: install project $project را نصب کنید
- کد منبع: github.com/$project/$project
- ردیاب مشکل: github.com/$project/$project/issues
نحوه مشارکت
نحوه گزارش یک باگ
- قبل از ارسال گزارش اشکال
- چگونه گزارش اشکال (خوب) ارسال کنم؟
نحوه ارسال تغییرات
- پروتکل های درخواست را بکشید
- پاسخ از تیم
- سرعت پاسخگویی
نحوه درخواست بهبود
- قبل از ارسال یک پیشنهاد بهبود
- چگونه یک پیشنهاد بهبود (خوب) ارائه کنم؟
اولین مشارکت کد شما
- مسائل مبتدی
- کمک خواست مسائل #### درخواست کشش
- فرآیند ایجاد درخواست کشش
- بررسی کنید که تمام بررسی های وضعیت در حال عبور هستند.
اگر بررسی وضعیت ناموفق باشد چه؟
- تست های نوشتاری
- پوشش تست
راهنمای سبک
- پیام های Git commit
- سبک استاندارد
پشتیبانی کنید
اگر مشکلی دارید، لطفا به ما اطلاع دهید. اگر به کمک نیاز دارید، می‌توانید سؤالات خود را در لیست پستی ما در آدرس: project@google-groups.com، چت IRC یا [لیست سایر پلت‌فرم‌های ارتباطی که پروژه شما از آن استفاده می‌کند، بپرسید.
مجوز
این بخش در مورد مجوز پروژه توضیح می دهد.
تعهد زمانی و ارتباط:
من 45+ ساعت در هفته می دهم اما در صورت بروز هر مشکلی، آن ساعت ها را در تعطیلات آخر هفته جبران می کنم. در طول دوره پیوند جامعه، در مورد وسایل ارتباطی بحث خواهم کرد و جلسات هفتگی، وسایل و زمان آن جلسات را با مربی خود نهایی خواهم کرد. من مربی خود را در مورد کارم به روز نگه خواهم داشت. جزئیات کارم را از طریق ایمیل با مربیم به اشتراک خواهد گذاشت. من TeamViewer را برای برقراری ارتباط ترجیح می دهم، زیرا استفاده از آن با بسیاری از ویژگی ها مانند صفحه نمایش اشتراک گذاری و غیره آسان است.