این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- چت تیم منبع باز Zulip
- نویسنده فنی:
- دروسا
- نام پروژه:
- Refactoring ReadTheDocs و API Docs
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
من روی دو حوزه تمرکز خواهم کرد و به موازات آنها کار خواهم کرد. یکی از آنها بهبود کیفیت zulip.readthedocs.io است تا مشارکت کنندگان جدید در طول مسیر کمتر دچار سردرگمی و تردید شوند. در حالت ایده‌آل، نتیجه یک مسیر واضح و مختصر از اولین مشارکت تا آشنایی با نحوه کار Zulip خواهد بود. من همچنین قصد دارم روی zulipchat.com/api ، api.md و openapi.md کار کنم تا فرآیند مستندسازی نقاط پایانی اضافی را آسان‌تر کنم. هر دو بخش احتمالاً شامل به‌روزرسانی/ساده‌سازی محتوا، حذف مقالات، اضافه کردن اسناد توسعه‌دهنده گمشده، و همچنین نوشتن/آزمایش کد می‌شود.
این پروژه شامل چهار فاز خواهد بود. مرحله اول شامل پروژه‌های آشنایی کوچک، ابزارهای آماده‌سازی و درک بهتر نیازهای اسناد فعلی خواهد بود. هدف از مرحله دوم ساختار، مشخص کردن و اولویت بندی کار در چارچوب اهداف زولیپ در فصل پاییز امسال خواهد بود. سپس به مرحله اجرای پروژه می‌روم. من با مربیان و بقیه انجمن توسعه دهندگان Zulip برای بازخورد به این سو و آن سو خواهم رفت. مرحله نهایی نگاه کردن به گذشته، تجدید نظر در جایی که نیاز است و نوشتن گزارش پروژه خواهد بود.
من گمان می‌کنم برخی اولویت‌ها و وظایف احتمالاً در طول دوره کاری تغییر می‌کنند، زیرا دیگران روی آن کار می‌کنند. از جمله تصمیمات اتخاذ شده توسط توسعه دهندگان اصلی. من انتظار دارم که یادگیری نحوه انطباق خوب با چنین تغییراتی جنبه ضروری داشتن یک تجربه موفق GSoD باشد. این امکان وجود دارد که در نقطه ای منطقی باشد که ایده های پیشنهادی را به بعد موکول کنید. به طور کلی، من بر این تمرکز خواهم داشت که مطمئن شوم کارم برای موفقیت کلی پروژه منبع باز Zulip ارزش دارد.