مشروع المحادثة الجماعية المفتوح المصدر من Zulip

تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".

ملخّص المشروع

مؤسسة مفتوحة المصدر:

المحادثة مع فريق البرامج المفتوحة المصدر Zulip

الكاتب الفني:

drrosa

اسم المشروع:

إعادة صياغة ReadTheDocs وAPI Docs

مدة المشروع:

المدة العادية (3 أشهر)

وصف المشروع

سأركّز على مجالَين وسأعمل عليهما بالتوازي. ويتمثل أحد هذه الإجراءات في تحسين جودة zulip.readthedocs.io حتى لا يواجه المساهمون الجدد أي ارتباك أو شكوك. ومن المفترَض أن تكون النتيجة مسارًا واضحًا وموجزًا، بدءًا من المساهمة للمرة الأولى وصولاً إلى التعرّف على طريقة عمل "زوليب". أخطّط أيضًا للعمل على zulipchat.com/api وapi.md وopenapi.md لتسهيل فهم عملية توثيق نقاط النهاية الإضافية. من المرجّح أن يتضمّن كلا الجزءَين تعديل المحتوى أو تبسيطَه، وإزالة المحتوى غير الهام من المقالات، وإضافة مستندات المطوّرين غير المتوفّرة، وكتابة الرموز البرمجية أو اختبارها.

سيتألف المشروع من أربع مراحل. ستتضمّن المرحلة الأولى مشاريع صغيرة للتعرّف على الأدوات التحضيرية وفهم احتياجات التوثيق الحالية بشكل أفضل. سيكون الغرض من المرحلة الثانية هو هيكلة العمل وتحديده وتحديد أولوياته في سياق أهداف Zulip في موسم الخريف القادم. بعد ذلك، سأنتقل إلى مرحلة تنفيذ المشروع. سأتواصل مع المرشدين وباقي أفراد منتدى المطوّرين في Zulip للحصول على ملاحظاتهم وآرائهم. ستكون المرحلة الأخيرة هي الرجوع إلى الوراء والمراجعة عند الحاجة وكتابة تقرير المشروع.

أعتقد أنّه من المحتمل أن تتغيّر بعض الأولويات والمهام خلال فترة العمل نتيجةً لما يعمل عليه الآخرون، بما في ذلك القرارات التي يتّخذها المطوّرون الأساسيون. أتوقع أنّ تعلُّم كيفية التكيّف بشكل جيد مع هذه التغييرات سيكون جانبًا ضروريًا للحصول على تجربة ناجحة في GSoD. من الممكن أن يكون من المنطقي في مرحلة ما تأجيل الأفكار المقترحة إلى وقت لاحق. بشكل عام، سأركّز على التأكّد من أنّ عملي يضيف قيمة إلى النجاح العام لمشروع Zulip المفتوح المصدر.