Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- Chat Tim Open Source Zulip
- {i>Technical writer <i}(Penulis teknis):
- drrosa
- Nama project:
- Pemfaktoran ulang ReadTheDocs dan Dokumen API
- Durasi project:
- Durasi standar (3 bulan)
Project description
Saya akan berfokus pada dua area dan mengerjakannya secara paralel. Salah satunya adalah meningkatkan kualitas zulip.readthedocs.io agar kontributor baru mengurangi kebingungan dan keraguan dalam prosesnya. Idealnya, hasilnya adalah jalur yang jelas dan ringkas dari kontribusi pertama kali hingga menjadi terbiasa dengan cara kerja Zulip. Saya juga berencana untuk mengerjakan zulipchat.com/api, api.md, dan openapi.md untuk mempermudah proses dokumentasi endpoint tambahan. Kedua bagian tersebut kemungkinan akan melibatkan pembaruan/penyederhanaan konten, pembersihan artikel, penambahan dokumentasi developer yang tidak ada, dan juga penulisan/pengujian kode.
Project ini akan terdiri dari empat fase. Tahap pertama akan mencakup proyek pengenalan kecil, peralatan persiapan, dan pemahaman yang lebih baik tentang kebutuhan dokumentasi saat ini. Tujuan fase kedua adalah menyusun, menentukan, dan memprioritaskan pekerjaan dalam konteks sasaran Zulip musim gugur ini. Kemudian, saya akan melanjutkan ke fase implementasi project. Saya akan berkomunikasi dengan mentor dan komunitas developer Zulip lainnya untuk mendapatkan masukan. Fase terakhir adalah melihat kembali, merevisi jika diperlukan, dan menulis laporan project.
Saya menduga beberapa prioritas dan tugas kemungkinan akan berubah selama periode kerja sebagai akibat dari pekerjaan orang lain; termasuk keputusan yang dibuat oleh developer inti. Saya berharap mempelajari cara beradaptasi dengan baik terhadap perubahan tersebut akan menjadi aspek yang diperlukan untuk mendapatkan pengalaman GSoD yang sukses. Mungkin pada suatu saat akan lebih baik untuk menunda ide yang diusulkan untuk nanti. Secara umum, saya akan berfokus untuk memastikan pekerjaan saya memberikan nilai tambah pada keberhasilan keseluruhan project open source Zulip.