Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Chat Tim Open Source Zulip
- Penulis teknis:
- drrosa
- Nama proyek:
- Pemfaktoran ulang ReadTheDocs dan Dokumen API
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Saya akan fokus pada dua area dan mengerjakannya secara paralel. Salah satunya adalah meningkatkan kualitas zulip.readthedocs.io sehingga kontributor baru tidak mengalami kebingungan dan keraguan selama prosesnya. Idealnya, hasilnya adalah jalur yang jelas dan ringkas, mulai dari kontribusi pertama hingga mengetahui cara kerja Zulip. Saya juga berencana mengerjakan zulipchat.com/api, api.md, dan openapi.md agar proses pendokumentasian endpoint tambahan lebih mudah dipahami. Kedua bagian ini kemungkinan akan melibatkan pembaruan/penyederhanaan konten, merapikan artikel, menambahkan dokumentasi developer yang hilang, dan juga menulis/menguji kode.
Proyek ini akan terdiri dari empat fase. Fase pertama akan mencakup proyek-proyek pemahaman kecil, peralatan persiapan, dan pemahaman yang lebih baik tentang kebutuhan dokumentasi saat ini. Tujuan fase kedua adalah menyusun, menentukan, dan memprioritaskan pekerjaan dalam konteks tujuan Zulip pada musim gugur ini. Kemudian saya akan beralih ke fase implementasi proyek. Saya akan berunding dengan mentor dan komunitas developer Zulip lainnya untuk meminta masukan. Fase terakhir adalah melihat kembali, merevisi jika perlu, dan menulis laporan proyek.
Saya menduga beberapa prioritas dan tugas mungkin berubah selama periode kerja sebagai akibat dari apa yang dikerjakan orang lain; termasuk keputusan yang dibuat oleh developer inti. Saya harap mempelajari cara beradaptasi dengan baik terhadap perubahan seperti itu akan menjadi aspek penting untuk memiliki pengalaman GSoD yang sukses. Ada kemungkinan bahwa pada suatu saat akan masuk akal untuk menunda ide yang diusulkan untuk keperluan di lain waktu. Secara umum, saya akan fokus untuk memastikan pekerjaan saya bernilai bagi keberhasilan keseluruhan proyek {i>open source<i} Zulip.