Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Zulip Açık Kaynak Ekibi Sohbeti
- Teknik yazar:
- drrosa
- Projenin adı:
- ReadTheDokümanlar ve API Dokümanları yeniden düzenleniyor
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
İki alana odaklanacağım ve paralel olarak bunlar üzerinde çalışacağım. Bunlardan biri, yeni katkıda bulunanların süreç boyunca daha az kafa karışıklığı ve şüphe yaşamaları için zulip.readthedocs.io kalitesinin iyileştirilmesidir. İdeal olarak sonuç, ilk kez yaptığınız katkıdan Zulip'in nasıl çalıştığını öğrenmeye kadar açık ve net bir yol olacaktır. Ek uç noktaları belgeleme işlemini daha anlaşılır hale getirmek için zulipchat.com/api, api.md ve openapi.md üzerinde de çalışmayı planlıyorum. Her iki bölümde de içeriğin güncellenmesi/basitleştirilmesi, makalelerin temizlenmesi, eksik geliştirici belgelerinin eklenmesi ve kod yazma/test edilmesi aşamalarında olabilir.
Proje dört aşamadan oluşacak. İlk aşama, küçük aşinalık projelerini, hazırlık araçlarını ve mevcut belgeleme ihtiyaçlarının daha iyi anlaşılmasını içerecek. İkinci aşamanın amacı, çalışmaları Zulip'in bu sonbahar dönemindeki hedefleri doğrultusunda yapılandırmak, belirlemek ve önceliklendirmek olacak. Sonra projenin uygulama aşamasına geçeceğim. Geri bildirim almak için mentorlarla ve Zulip'in geliştirici topluluğundaki diğer kişilerle görüşeceğim. Son aşamada geriye dönüp gereken yerlerde düzeltmeler yapmak ve proje raporunu yazmak yer alacak.
Çekirdek geliştiricilerin verdiği kararlar da dahil olmak üzere herkesin üzerinde çalıştığı çalışmaların sonucu olarak bazı önceliklerin ve görevlerin çalışma süresi boyunca değişebileceğinden şüpheleniyorum. Bu tür değişikliklere nasıl uyum sağlayacağınızı öğrenmenin, başarılı bir GSoD deneyimi yaşamak için gerekli olacağını düşünüyorum. Önerilen fikirleri daha sonraya ertelemek bir noktada mantıklı olabilir. Genel olarak, çalışmamın Zulip açık kaynak projesinin genel başarısına değer katmasını sağlamaya odaklanacağım.