Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Django
- Penulis teknis:
- Gabbyprecious
- Nama project:
- Menulis ulang Panduan kontribusi agar lebih mudah digunakan dan dijelajahi
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
ABSTRACT
Tujuan dari panduan kontribusi Django seperti dokumentasi lainnya adalah untuk memandu pengguna, kontributor {i>open-source<i} dalam hal ini tentang bagaimana dan di mana mereka dapat berkontribusi untuk membuat Django lebih baik dan berkelanjutan.
Selalu ada kebutuhan untuk membuat dokumentasi, terutama yang sangat memengaruhi komunitas dan Django itu sendiri.
Sasaran Django untuk Google Summer of Docs tahun ini adalah membuat Panduan kontribusi menjadi lebih mudah dipahami, mudah diakses, dan menarik bagi kontributor. Ini adalah sasaran yang penting karena mendorong kontributor, yang saya sendiri termasuk di dalamnya, untuk mulai berkontribusi pada framework yang luar biasa ini.
Status Saat Ini
Tahap dokumentasi saat ini yang dapat ditemukan di sini, bukanlah panduan yang sebenarnya karena terlalu melelahkan dan tidak terstruktur dengan baik serta menyebabkan pemahaman tentang kontribusi di Django yang kurang memadai dan tidak menyambut kontributor baru.
Tujuan Proyek
Saya membahas saran saya untuk dokumentasi dengan mentor saya, Carlton Gibson di forum dan dia menyetujui bahwa saran saya akan membantu mengatasi masalah yang merepotkan terkait dokumentasi saat ini. Berikut adalah sasaran yang saya rencanakan untuk mencapai penyusunan ulang dokumen: Menyusun ulang dokumen Menambahkan bagian Dosa dan Larangan Membuat satu halaman untuk bagian-bagian yang tidak penting seperti Meminta dan membuat fitur Dokumentasi yang dipersingkat dan langsung ke intinya Glosarium untuk kata-kata Indeks Internal yang dibuat untuk mengikuti panduan baru Menulis dokumentasi yang lebih mudah dipahami Mengelompokkan konten menjadi dua bagian utama (bagian Kontributor Pemula dan Lanjutan) Membuat panduan dan gaya untuk penulis/kontributor teknis baru, agar dokumen selalu diperbarui dan mengikuti standar.
Dokumentasi saat ini sudah ditargetkan untuk kontributor tingkat lanjut, dan tidak memberikan kesempatan kepada kontributor baru dan pemula untuk open source dan Django. Berikut beberapa konten tambahan untuk pemula: Bagian yang memandu berbagai kumpulan kontributor(penulis teknis, desainer, dan developer) Halaman yang mendokumentasikan masalah pemula dan masalah mudah yang dapat dipecahkan. Ambil beberapa bagian dalam dokumentasi saat ini, tulis ulang, dan tambahkan ke bagian pemula. Bagian yang menjelaskan poin-poin utama atau kata-kata yang digunakan di bagian lanjutan.
Linimasa
Berikut adalah perincian tentang cara saya ingin mengerjakan sasaran project seperti yang tercantum di atas dengan kalender yang disediakan oleh Google.
Alat
Sphinx - alat saat ini untuk dokumentasi saat ini. Baca Dokumen.
Mengapa Project ini?
Saya sangat percaya pada 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 ingin berkontribusi pada Django sebagai pemula dan saya pikir ini adalah cara yang tepat untuk berkontribusi pada alat favorit saya, sekaligus mengenal codebase untuk menawarkan lebih banyak kontribusi sebagai developer(dan penulis teknis). Akan menyenangkan dan indah untuk bekerja dengan organisasi yang selaras dengan pandangan saya dan telah menjadi alat yang hebat untuk seluruh karier saya.
Mengapa saya orang yang tepat untuk project ini?
Saya yakin saya adalah orang yang tepat berdasarkan alasan berikut: Saya telah berkontribusi pada Django dengan menulis artikel untuk membantu pemula lebih memahami konsep Django. Sebagai developer dan orang yang ingin berkontribusi pada Django, saya memahami kebutuhan sesama developer dan cara mendokumentasikannya dengan baik untuk mereka. Saya adalah pemain tim dan akan bekerja dengan baik dengan pengawasan yang lebih sedikit atau lebih banyak dari mentor saya, Carlton Gibson.