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:
- Django
- Teknik yazar:
- Gabbydeğerli
- Projenin adı:
- Katkı kılavuzunu daha kullanıcı dostu olacak ve daha kolay gezinilecek şekilde yeniden yazın
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
ÖZET
Diğer tüm belgeler gibi Django'nun katkı rehberinin amacı, bu örnekte açık kaynak katkıda bulunan kullanıcılara, Django'nun daha iyi ve sürdürülebilir olmasına nasıl ve nerede katkıda bulunabilecekleri konusunda yol göstermektir.
Her zaman için, topluluğu ve Django'nun kendisini önemli ölçüde etkileyen belgeler hazırlamanız gerekir.
Django'nun bu yılki Google Dokümanlar Yaz etkinliği için amacı, Katkı kılavuzunu daha zorlayıcı, erişilebilir ve katkıda bulunanlar için daha hoşgörülü hale getirmektir. Bu, katkıda bulunanları teşvik ettiği için çok önemli bir hedef. Bu harika çerçeveye katkıda bulunmaya başlarken ben de katkıda bulunuyorum.
Mevcut Durum
Belgelemenin burada yer alan mevcut aşaması çok zorlayıcı ve iyi yapılandırılmamış olduğu, Django'nun katkılarının daha az anlaşılmasına ve katkıda bulunanların yeni sayısının azalmasına yol açtığı için pek yol gösterici değildir.
Proje Hedefleri
Belgelemeyle ilgili önerilerim hakkında mentorum Carlton Gibson'ı forumda konuştum ve mevcut dokümanlarla ilgili bu büyük soruna yardımcı olacağını onaylıyor. Belgeyi yeniden yapılandırmak için yapmayı planladığım hedefler şunlardır: Belgeyi yeniden yapılandırın. Bölüm düzeyinde Yapılacaklar ve Yapılmayacaklar bölümü ekleyin Özellik İsteme ve Yapılmayacaklar gibi önemsiz bölümler için tek sayfa oluşturun Özellik isteğinde bulunma ve doğrudan ekleme gibi önemsiz bölümler için tek bir sayfa oluşturun Kısaltılmış ve doğrudan işaret eden dokümanlar Kelimeler için sözlük Yeni kılavuza uygun şekilde oluşturulan Dahili Dizin Daha anlaşılır ve samimi bir belge yazın Stilinizi iki ana bölüme ayırın ve yeni başlayanlar/katkıda bulunanlar için bir kılavuz hazırlayın (Yeni başlayanlar/katkıda bulunanlar kılavuzu için)
Mevcut dokümanlar hâlihazırda ileri düzey katkıda bulunan kullanıcıları hedeflemektedir ve hem açık kaynak hem de Django'ya yeni ve yeni katkıda bulunan kullanıcılara fırsat tanımaz. Burada, yeni başlayanlar için bazı ek içerikler verilmiştir: Farklı katkıda bulunanlar grubuna(teknik yazarlar, tasarımcılar ve geliştiriciler) rehberlik eden bölüm İlk zamanlayıcı sorunlarını ve çözüleebilecek kolay sorunları belgeleyen bir sayfa. Mevcut dokümanlardan birkaç bölümü alıp yeniden yazın ve yeni başlayanlar bölümüne ekleyin. Gelişmiş bölümde kullanılan önemli noktaları veya kelimeleri açıklayan bölümler.
Zaman çizelgesi
Google tarafından sağlanan takvimle birlikte, yukarıda listelenen proje hedefi üzerinde nasıl çalışmak istediğime dair bir döküm de paylaşacağım.
Toplulukla bağ kurma haftası( 17 Ağustos - 13 Eylül) Toplulukla daha çok etkileşime geçin 10. Hafta için Teknik Belge Oluşturma ve 1. Hafta: Yeni İçerik Hazırlama ve Bağış Yapılacak İşleri Hazırlama 1. Haftada Yeni İçerik Hazırlama ve Bağış Yapılacak İşleri Hazırlama 1. Hafta için İçerik Hazırlama ve Bağış Yapılacak İşleri Hazırlama 1. Hafta, İçerik Hazırlama ve Yapılacak İş Listesi Hazırlama 1. Hafta, İçerik Hazırlama ve Yapılacak İş Listesi Hazırlama 1. Hafta, İçerik Hazırlama ve Yapılacak İş Listesi Hazırlama 1. Hafta, Katkıda Bulunan Kullanıcı Rehberi ve Yapılacak İşleri Hazırlama 1. Hafta, Katkıda Bulunan Kullanıcılardan Daha Fazla Öneri Alma Mevcut Belgeler ve Amaçlanan Araçlar Hakkında Daha Fazla Çalışma
Araçlar
Sfenks - Güncel belgeleme aracı. Belgeleri okuyun.
Neden bu Proje?
Dünyanın dört bir yanındaki herkesi kapsayacak şekilde iyi yazılmış dokümanlara ve makalelere inanan biriyim. Bunun yanı sıra Django'yu ve Açık kaynağı da genel olarak seviyorum. Yeni başlayan biri olarak Django'ya katkıda bulunmak istedim. Bunun hem en sevdiğim araca katkıda bulunmanın hem de geliştirici(ve teknik yazar) olarak daha fazla katkı sunmak üzere kod tabanını tanımanın mükemmel bir yolu olduğunu düşünüyorum. Görüşlerimle uyumlu olan ve tüm kariyerim için harika bir araç olan bir kuruluşla çalışmak hoş ve güzel olacak.
Neden bu proje için doğru kişiyim?
Aşağıdaki hesapları dikkate alarak doğru kişi olduğuma inanıyorum: Yeni başlayanların Django kavramını daha iyi anlamalarına yardımcı olacak makaleler yazarak Django'ya katkıda bulunuyorum. Bir geliştirici olarak Django'ya katkıda bulunmaya istekli biri olarak diğer geliştiricilerin ihtiyacını ve bunu onlar için nasıl iyi bir şekilde belgeleyebileceğimi anlıyorum. Takım oyuncusuyum ve mentorum Carlton Gibson'ın daha az ya da daha çok gözetimi altında iyi çalışacağım.