Fase saat ini:
Pengembangan dokumentasi. Lihat
linimasa.
Halaman ini berisi tips untuk organisasi open source tentang cara menilai dan memilih penulis teknis yang tepat untuk proposal project Google Season of Docs mereka.
Pengantar
Organisasi Open Source harus mempekerjakan penulis teknis untuk mengerjakan project yang diusulkan. Organisasi harus mencari penulis teknis mereka sendiri. Penulis teknis yang tertarik untuk bekerja sama dengan organisasi yang berpartisipasi dalam Google Season of Docs dapat ditemukan di repo GitHub Google Season of Docs, dan di channel#season-of-docs di Write the Docs Slack.
Memulai proses
Sebaiknya mulai proses pencarian penulis teknis sesegera mungkin sesuai keinginan Anda untuk berpartisipasi dalam Google Season Dokumen.
Menilai seorang penulis teknis
Sebaiknya Anda meminta contoh dokumentasi yang telah dikembangkan sebelumnya dari penulis teknis yang Anda pertimbangkan, sehingga Anda dapat mengevaluasi keterampilan dan pengalaman menulis teknis mereka.
Keterampilan dan pengalaman menulis teknis
Periksa pengalaman penulis teknis sebelumnya. Idealnya, penulis teknis harus memiliki pengalaman sebelumnya dalam menulis dokumentasi teknis untuk industri software. Salah satu tujuan Google Season of Docs adalah memberikan kesempatan kepada penulis teknis untuk terlibat dengan produk yang berfokus pada developer. Oleh karena itu, penulis tidak harus memiliki pengalaman dengan API atau SDK atau platform developer lainnya, meskipun project Anda berfokus pada audiens developer.
Fokus pada keterampilan bahasa dan komunikasi. Mengevaluasi pekerjaan sebelumnya dari penulis teknis dari sudut pandang ini. Yang paling penting: Bisakah Anda memahami apa yang ditulis orang tersebut? Jika Anda ingin melakukan tinjauan mendalam tentang bahasa karya penulis teknis, cari konsistensi dalam tanda baca dan frasa, ejaan yang benar, dan bahasa yang jelas. Apakah ungkapannya sederhana atau rumit? Apakah kalimatnya singkat atau berlangsung sampai sulit diikuti?
Perhatikan desain dan tata letak dokumen. Periksa tata letak keseluruhan contoh dokumen. Apakah desainnya logis? Dapatkah Anda menemukan dokumen atau kumpulan dokumentasi dengan mudah? Apakah ada duplikasi konten atau ada kesenjangan yang jelas?
Mempekerjakan seorang penulis teknis
Organisasi harus mempekerjakan penulis teknis dan melengkapi Formulir Perekrutan Bukti Teknis Penulis yang ditautkan di bawah, paling lambat 22 Mei 2024 pukul 18.00 UTC.
Formulir Bukti Perekrutan Penulis Teknis
Pastikan untuk mendiskusikan kompensasi dan jadwal pembayaran dengan penulis teknis sebelum melakukan perekrutan. Sebaiknya organisasi membuat jadwal pembayaran dengan penulis teknis berdasarkan pencapaian project, termasuk pembayaran saat memulai project. Perhatikan tanggal pembayaran, yang hanya akan terjadi dua kali selama program, dan jumlah saat membuat jadwal pembayaran.
Catatan: Organisasi yang belum merekrut penulis teknologi dan mengirimkan Bukti Formulir Perekrutan Penulis Teknis paling lambat 22 Mei 2024 pukul 18.00 UTC tidak akan menerima dana pada tanggal pencairan pertama.