Memilih penulis teknis

Fase saat ini:
Hasil diumumkan. Lihat linimasa.

Halaman ini berisi tips untuk organisasi open source tentang cara menilai dan memilih penulis teknis yang tepat untuk proposal proyek Google Season Dokumen mereka.

Pengantar

Organisasi Open Source harus mempekerjakan penulis teknis untuk mengerjakan project yang mereka usulkan. Organisasi harus menyediakan penulis teknisnya 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 saluran#season-of-docs di Slack Write the Docs.

Memulai proses

Sebaiknya mulailah proses menemukan penulis teknis begitu Anda merasa ingin berpartisipasi dalam Google Season of Docs.

Menilai seorang penulis teknis

Sebaiknya minta contoh dokumentasi yang telah dikembangkan sebelumnya dari penulis teknis yang Anda pertimbangkan, sehingga Anda dapat berfokus pada mengevaluasi keterampilan dan pengalaman penulisan teknis mereka.

Keterampilan dan pengalaman menulis teknis

  • Periksa pengalaman sebelumnya dari penulis teknis. Idealnya, penulis teknis harus memiliki pengalaman sebelumnya dalam menulis dokumentasi teknis untuk industri software. Salah satu sasaran Google Season of Docs adalah memberi penulis teknis kesempatan untuk terlibat dengan produk yang berfokus pada developer. Karena alasan itu, penulis tidak perlu memiliki pengalaman dengan API atau SDK atau platform developer lainnya, meskipun project Anda berfokus pada audiens developer.

  • Fokus pada keterampilan bahasa dan komunikasi. Evaluasi pekerjaan sebelumnya dari penulis teknis dari sudut pandang ini. Yang paling penting: Dapatkah Anda memahami apa yang ditulis orang tersebut? Jika Anda ingin melakukan peninjauan mendalam terhadap bahasa karya penulis teknis, cari konsistensi dalam tanda baca dan frasa, ejaan yang benar, dan bahasa yang jelas. Apakah frasa tersebut sederhana atau rumit? Apakah kalimatnya singkat atau panjang sampai sulit diikuti?

  • Perhatikan desain dan tata letak dokumen. Periksa keseluruhan tata letak contoh dokumen. Apakah desainnya logis? Dapatkah Anda dengan mudah menemukan dokumen atau kumpulan dokumentasi? Apakah ada duplikasi konten atau ada kesenjangan yang jelas?

Mempekerjakan penulis teknis

Organisasi harus mempekerjakan penulis teknis dan melengkapi Bukti Formulir Pengadaan Penulis Teknis yang ditautkan di bawah ini paling lambat 10 Mei 2023 pukul 18.00 UTC.

Fase perekrutan penulis teknis selesai.

Pastikan untuk mendiskusikan kompensasi dan jadwal pembayaran dengan penulis teknis sebelum mempekerjakannya. Sebaiknya organisasi membuat jadwal pembayaran dengan penulis teknis berdasarkan tonggak pencapaian project, termasuk pembayaran saat project dimulai. Perhatikan tanggal pembayaran, yang hanya akan terjadi dua kali selama program, dan jumlah saat membuat jadwal pembayaran.

Catatan: Organisasi yang belum mempekerjakan penulis teknologi dan mengirimkan Bukti Formulir Perekrutan Penulis Teknis paling lambat 10 Mei 2023 pukul 18.00 UTC tidak akan menerima dana pada tanggal pencairan pertama.