تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- محادثة فريق Zulip مفتوحة المصدر
- الكاتب التقني:
- دراوسا
- اسم المشروع:
- إعادة هيكلة مستندات ReadThe Docs وواجهة برمجة التطبيقات
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
سأركز على مجالين وأعمل عليهما بالتوازي. من بينها تحسين جودة zulip.readthedocs.io بحيث يشعر المساهمون الجدد بقدر أقل من الالتباس والشكوك خلال العملية. من الناحية المثالية، ستكون النتيجة مسارًا واضحًا وموجزًا بدءًا من المساهمة الأولى وحتى التعرّف على طريقة عمل "زوليب". أخطط أيضًا للعمل على zulipchat.com/api وapi.md وopenapi.md لتسهيل فهم عملية تسجيل نقاط النهاية الإضافية. ومن المرجح أن يتضمن كلا الجزأين تحديث/تبسيط المحتوى، ترتيب المقالات، إضافة وثائق مطوري البرامج المفقودة، وكذلك كتابة/اختبار التعليمات البرمجية.
سيتألف المشروع من أربع مراحل. ستشمل المرحلة الأولى مشروعات تعريف صغيرة وأدوات تحضيرية وفهمًا أفضل لاحتياجات التوثيق الحالية. سيكون الغرض من المرحلة الثانية هو تنظيم العمل وتحديده وترتيبه حسب الأولوية ضمن سياق أهداف زوليب في موسم الخريف هذا. ثم سأنتقل إلى مرحلة تنفيذ المشروع. سأتواصل ذهابًا وإيابًا مع المرشدين وبقية منتدى المطورين في Zulip للحصول على التعليقات. ستكون المرحلة الأخيرة هي الرجوع إلى الوراء والمراجعة حيثما لزم الأمر وكتابة تقرير المشروع.
أعتقد أنه من المحتمل أن تتغير بعض الأولويات والمهام طوال فترة العمل نتيجة لما يعمل عليه الجميع؛ بما في ذلك القرارات التي يتخذها المطورون الأساسيون. أتوقع أن تعلم كيفية التكيف بشكل جيد مع هذه التغييرات سيكون جانبًا ضروريًا للحصول على تجربة GSoD ناجحة. من الممكن أن يكون من المنطقي في مرحلة ما تأجيل الأفكار المقترحة إلى وقت لاحق. بشكل عام، سأركز على التأكد من أن عملي يجلب قيمة للنجاح العام لمشروع Zulip مفتوح المصدر.