Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Zulip Açık Kaynak Ekip Sohbeti
- Teknik yazar:
- drrosa
- Proje adı:
- ReadTheDocs ve API Dokümanları'nın yeniden yapılandırılması
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
İki alana odaklanıp bunlar üzerinde paralel olarak çalışacağım. Bunlardan biri, yeni katkıda bulunanların daha az kafa karışıklığı ve şüpheyle karşılaşması için zulip.readthedocs.io'nun kalitesini iyileştirmek. İdeal olarak, ilk katkıdan Zulip'in işleyiş şeklini öğrenmeye kadar net ve kısa bir yol elde ederiz. Ayrıca, ek uç noktaları belgeleme sürecini daha kolay anlaşılır hale getirmek için zulipchat.com/api, api.md ve openapi.md üzerinde çalışmayı planlıyorum. Her iki bölümde de içeriği güncelleme/basitleştirme, makalelerde dağınıklığı giderme, eksik geliştirici dokümanlarını ekleme ve kod yazma/test etme gibi işlemler yer alabilir.
Proje dört aşamadan oluşuyor. İlk aşamada küçük oryantasyon projeleri, hazırlık araçları ve mevcut dokümanlama ihtiyaçlarının daha iyi anlaşılması yer alacak. İkinci aşamanın amacı, Zulip'in bu sonbahar sezonundaki hedefleri bağlamında işleri yapılandırmak, belirtmek ve önceliklendirmektir. Ardından projenin uygulama aşamasına geçeceğim. Geri bildirim almak için mentorlarla ve Zulip'in diğer geliştiricileriyle iletişime geçeceğim. Son aşama geri dönüp gereken yerlerde revize etmek ve proje raporunu yazmaktır.
Temel geliştiriciler tarafından alınan kararlar da dahil olmak üzere diğer herkesin üzerinde çalıştığı işler nedeniyle bazı önceliklerin ve görevlerin çalışma dönemi boyunca değişebileceğini düşünüyorum. Bu tür değişikliklere nasıl uyum sağlayacağınızı öğrenmenin, GSoD deneyiminizde başarılı olmanın gerekli bir parçası olacağını düşünüyorum. Önerilen fikirleri daha sonraya ertelemek bazen mantıklı olabilir. Genel olarak, yaptığım çalışmaların Zulip açık kaynak projesinin genel başarısına değer katmasını sağlamaya odaklanacağım.