Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Django
- Penulis teknis:
- Gabbyprecious
- Nama proyek:
- Panduan Tulis Ulang Kontribusi agar lebih mudah digunakan dan dijelajahi
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
ABSTRAK
Tujuan panduan kontribusi Django seperti dokumentasi lainnya adalah untuk memandu pengguna, kontributor open-source, dalam hal ini tentang bagaimana dan di mana mereka dapat berkontribusi untuk membuat Django lebih baik dan berkelanjutan.
Anda selalu perlu membuat dokumentasi, terutama dokumentasi yang sangat memengaruhi komunitas dan Django itu sendiri.
Tujuan Django pada Google Summer of Docs tahun ini adalah untuk membuat panduan Kontribusi tidak terlalu membingungkan, mudah diakses, dan menyambut kontributor. Ini adalah sasaran yang penting karena mendorong kontributor, yang saya adalah anggotanya saat mulai berkontribusi ke kerangka kerja yang hebat ini.
Status Saat Ini
Tahap dokumentasi saat ini yang dapat ditemukan di sini, bukanlah panduan karena terlalu berlebihan dan tidak terstruktur dengan baik dan menyebabkan kurang memahami kontribusi di Django dan tidak menyambut kontributor baru.
Tujuan Proyek
Saya mendiskusikan saran saya untuk dokumentasi dengan mentor saya, Carlton Gibson di forum dan dia setuju bahwa hal itu akan membantu mengatasi masalah yang luar biasa dengan dokumentasi saat ini. Berikut adalah sasaran yang saya rencanakan untuk menyusun ulang dokumen: Menyusun ulang dokumen Tambahkan Anjuran dan Larangan untuk bagian Membuat satu halaman untuk bagian sepele seperti Meminta dan membuat fitur Dokumentasi singkat dan ringkas Glosarium untuk kata Indeks Internal yang dibuat untuk mengikuti panduan baru Menulis dokumentasi ramah yang lebih relevan Menyegmentasikan konten menjadi dua bagian utama (bagian Pemula dan Kontributor Tingkat Lanjut) Membuat standar penulis
Dokumentasi saat ini sudah ditargetkan untuk kontributor tingkat lanjut, dan tidak memberi peluang kepada kontributor baru dan pemula, baik untuk open source maupun Django, berikut beberapa konten tambahan untuk pemula: Bagian yang memandu kumpulan kontributor yang berbeda(penulis teknis, desainer, dan developer) Halaman yang mendokumentasikan masalah-masalah awal dan masalah mudah yang dapat diselesaikan. Ambil beberapa bagian dalam dokumentasi saat ini, kemudian tulis ulang dan tambahkan ke bagian pemula. Bagian yang menjelaskan poin-poin penting atau kata-kata yang digunakan dalam bagian lanjutan.
Rentang waktu
Berikut adalah perincian tentang bagaimana saya ingin mengerjakan tujuan proyek seperti yang tercantum di atas dengan kalender yang disediakan oleh Google.
Minggu pengikatan komunitas( 17 Agustus - 13 September) Perbanyak keterlibatan lebih banyak dengan komunitas Pergerakan hubungan kerja dengan komunitas Terus berkontribusi pada dokumentasi Dapatkan lebih banyak saran dari Kontributor Studi lebih banyak tentang Dokumentasi saat ini dan alat yang dimaksud Minggu 1 - minggu 4 Mulai dengan membagi dokumentasi berdasarkan Level Membuat bagian pemula dalam dokumentasi Minggu 4 - 6 Dokumentasi yang masuk
Alat
Sphinx - alat terkini untuk dokumentasi terkini. Baca Dokumentasi.
Mengapa Project ini?
Saya sangat percaya diri dengan dokumentasi dan artikel yang ditulis dengan baik untuk mencakup semua orang di seluruh dunia. Selain itu, saya juga menyukai Django dan Open source secara keseluruhan. Saya bermaksud untuk berkontribusi pada Django sebagai pemula dan saya pikir ini adalah cara sempurna untuk berkontribusi pada alat favorit saya, sekaligus berkenalan dengan codebase untuk menawarkan lebih banyak kontribusi sebagai developer(dan penulis teknis). Pasti menyenangkan dan bisa bekerja dengan organisasi yang sesuai dengan pandangan saya dan telah menjadi alat yang hebat untuk seluruh karier saya.
Mengapa saya adalah orang yang tepat untuk proyek ini?
Saya percaya saya orang yang tepat berdasarkan akun berikut: Saya telah berkontribusi untuk Django dengan menulis artikel untuk membantu pemula memahami konsep Django lebih lanjut. Sebagai developer dan berharap dapat berkontribusi pada Django, saya memahami kebutuhan sesama developer dan cara mendokumentasikannya dengan baik untuk mereka. Saya adalah pemain tim dan akan bekerja dengan baik di bawah pengawasan kurang atau lebih dari mentor saya, Carlton Gibson.