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:
- Django
- Teknik yazar:
- Gabbyprecious
- Projenin adı:
- Katkı kılavuzunu daha kullanıcı dostu ve kolay gezinilebilir olacak şekilde yeniden yazın
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
ABSTRACT
Diğer tüm dokümanlar gibi Django'nun katkı kılavuzunun amacı da kullanıcılara ve açık kaynak katkıda bulunanlara Django'yu daha iyi ve sürdürülebilir hale getirmek için nasıl ve nerede katkıda bulunabilecekleri konusunda yol göstermektir.
Özellikle topluluğu ve Django'yu büyük ölçüde etkileyen dokümanlar oluşturmak her zaman gereklidir.
Django'nun bu yılki Google Yaz Dokümanları etkinliğindeki hedefi, Katkı Rehberi'ni katkıda bulunanlar için daha az göz korkutucu, erişilebilir ve samimi hale getirmektir. Bu, katkıda bulunanları teşvik ettiği için önemli bir hedeftir. Ben de bu harika çerçeveye katkıda bulunmaya başladığımda katkıda bulunanlar arasındaydım.
Mevcut Durum
Burada bulabileceğiniz dokümanların mevcut aşaması, çok fazla bilgi içerdiği ve iyi yapılandırılmadığı için rehber olarak pek uygun değil. Ayrıca, Django'ya katkıda bulunma konusunda daha az bilgi sahibi olmanıza neden oluyor ve yeni katkıda bulunanları memnun etmiyor.
Proje Hedefleri
Dokümanlar için önerilerimi, forumdaki danışmanım Carlton Gibson ile görüştüm. Carlton, önerilerimin mevcut dokümanlardaki büyük soruna yardımcı olacağını onayladı. Belgeyi yeniden yapılandırarak şu hedeflere ulaşmak istiyorum: Belgeyi yeniden yapılandırın Bölümlere göre yapılması ve yapılmaması gerekenleri ekleyin Özellik isteğinde bulunma ve özellik oluşturma gibi önemsiz bölümler için tek sayfalar oluşturun Azaltılmış ve konuya doğrudan odaklanan dokümanlar yazdırın Kelimeler için sözlük Yeni kılavuza uygun şekilde oluşturulmuş dahili dizin Daha anlaşılır ve kullanıcı dostu dokümanlar yazın İçerikleri iki ana bölüme ayırın (Yeni Başlayanlar ve İleri Düzey Katkıda Bulunanlar bölümü) Dokümanları güncel tutmak ve standartlara uymak için yeni teknik yazarlar/katkıda bulunanlar için bir kılavuz ve stil oluşturun.
Mevcut dokümanlar ileri düzey katkıda bulunanları hedefliyor ve hem açık kaynak hem de Django'ya yeni başlayanlara fırsat tanımıyor. Yeni başlayanlar için ek içerikler aşağıda verilmiştir: Farklı katkıda bulunanlara(teknik yazarlar, tasarımcılar ve geliştiriciler) rehberlik eden bölüm Yeni başlayanların karşılaşabileceği sorunları ve kolayca çözülebilecek sorunları açıklayan bir sayfa. Mevcut belgelerde birkaç bölüme yer verin, belgeyi yeniden yazın ve yeni başlayanlar bölümüne ekleyin. İleri seviye bölümünde kullanılan önemli noktaları veya kelimeleri açıklayan bölümler.
Zaman çizelgesi
Aşağıda, Google tarafından sağlanan takvimle yukarıda listelenen proje hedefi üzerinde nasıl çalışmak istediğime dair bir döküm yer almaktadır.
Toplulukla kaynaşma haftası( 17 Ağustos - 13 Eylül) Toplulukla daha fazla etkileşime geçme Belgelere katkıda bulunmaya devam etme Katkıda bulunanlardan daha fazla öneri alma Mevcut dokümanlar ve amaçlanan araçlar hakkında daha fazla çalışma yapma 1. hafta - 4. hafta Seviyelere göre dokümanları bölümlere ayırmaya başlama Belgelerin başlangıç bölümüne yönelik içerik oluşturma 4. hafta - 6. hafta Yapılması ve yapılmaması gerekenleri derleme Bölümlere yönelik yapılması ve yapılmaması gerekenleri yazma Bölümler için ek sayfalar oluşturma 7. hafta - 9. hafta Mevcut dokümanları yeniden yazıp ileri seviye katkıda bulunanlar kılavuzuna taşıma Daha az doküman oluşturma 10. hafta - 12. hafta Sözlük hazırlama Dahili dizini yeni dokümanlarla güncelleme Yeni teknik yazarlar/katkıda bulunanlar için bir kılavuz ve stil oluşturma
Araçlar
Sphinx: Mevcut dokümanlar için kullanılan mevcut araç. Read the Docs'u okuyun.
Neden bu proje?
Dünyanın her yerindeki herkesi kapsayan, iyi yazılmış belge ve makalelere yürekten inanıyorum. Bunun dışında Django ve açık kaynak yazılımları da seviyorum. Django'ya yeni başlayan biri olarak katkıda bulunmak istiyordum. Bu, hem en sevdiğim araca katkıda bulunmanın hem de geliştirici(ve teknik yazar) olarak daha fazla katkıda bulunmak için kod tabanıyla tanışmanın mükemmel bir yolu. Görüşlerime uygun olan ve kariyerim boyunca harika bir araç olan bir kuruluşla çalışmaktan memnuniyet duyarım.
Neden bu proje için doğru kişi benim?
Aşağıdaki nedenlerden dolayı doğru kişi olduğumu düşünüyorum: Yeni başlayanların Django kavramını daha iyi anlamasına yardımcı olacak makaleler yazarak Django'ya katkıda bulunuyorum. Bir geliştirici ve Django'ya katkıda bulunmak isteyen biri olarak, diğer geliştiricilerin ihtiyaçlarını ve bu ihtiyaçların nasıl iyi bir şekilde belgeleneceğini anlıyorum. Ekip çalışmasına önem veririm ve mentorum Carlton Gibson'un daha az veya daha fazla gözetiminde iyi çalışırım.