Project Chat Tim Open Source Zulip
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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.
Kecuali disebutkan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-11-08 UTC.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2024-11-08 UTC."],[[["This project aims to improve the Zulip developer documentation for easier contribution and understanding."],["The focus is on refining ReadTheDocs for new contributors and enhancing API documentation for easier endpoint documentation."],["The project will involve restructuring, simplifying, and adding content, along with code writing and testing."],["The project is divided into four phases, starting with familiarization and ending with a final report, with continuous feedback and adaptation."],["The project's success is measured by its contribution to the overall success of the Zulip open-source project."]]],["The project focuses on improving Zulip's documentation for contributors and developers. Key actions include enhancing the clarity and conciseness of `zulip.readthedocs.io`, and improving the ease of documenting API endpoints on `zulipchat.com/api`, `api.md`, and `openapi.md`. The work will involve updating content, decluttering articles, adding missing information, and testing code. The project will unfold in four phases: familiarization, structuring/prioritization, implementation, and revision/reporting, with ongoing feedback from the Zulip community. The project will be adaptable to potential changes in priorities.\n"]]
