Tahap saat ini:
Hasil diumumkan
linimasa.
Halaman ini berisi tips untuk organisasi open source tentang cara menilai dan memilih penulis teknis yang tepat untuk proposal project Season of Docs mereka.
Pengantar
Organisasi Open Source harus mempekerjakan penulis teknis untuk mengerjakan project yang diusulkan. Organisasi harus mendapatkan penulis teknis sendiri. Penulis teknis yang tertarik untuk bekerja sama dengan organisasi yang berpartisipasi dalam Season Dokumen dapat ditemukan di repo GitHub Season Dokumen, dan di channel#season-of-docs di Slack Dokumen.
Memulai proses
Sebaiknya mulai proses pencarian penulis teknis sesegera mungkin jika Anda ingin berpartisipasi dalam Season Dokumen.
Menilai seorang penulis teknis
Sebaiknya minta contoh dokumentasi yang telah dikembangkan sebelumnya dari penulis teknis yang Anda pertimbangkan, sehingga Anda dapat berfokus untuk 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 tujuan Season of Docs adalah memberi penulis teknis kesempatan 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 tersebut dari sudut pandang ini. Yang paling penting: Bisakah Anda memahami apa yang ditulis orang itu? Jika Anda ingin melakukan tinjauan mendalam tentang bahasa karya penulis teknis, cari konsistensi tanda baca dan frasa, ejaan yang benar, dan bahasa yang jelas. Apakah kalimatnya sederhana atau rumit? Apakah kalimatnya pendek atau terus berjalan 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 Proof of Technical Writer yang ditautkan di bawah paling lambat 16 Mei 2022 pukul 18.00 UTC.
Fase perekrutan penulis teknis selesai.
Pastikan untuk mendiskusikan kompensasi dan jadwal pembayaran dengan penulis teknis sebelum merekrut. Sebaiknya organisasi membuat jadwal pembayaran dengan penulis teknis berdasarkan pencapaian project, termasuk pembayaran saat dimulainya project. Harap perhatikan tanggal pembayaran, yang hanya akan terjadi dua kali dalam program, dan jumlahnya saat membuat jadwal pembayaran.
Catatan: Organisasi yang belum mempekerjakan penulis teknologi dan mengirimkan Formulir Perekrutan Penulis Teknis paling lambat 16 Mei 2022 pukul 18.00 UTC tidak akan menerima dana pada tanggal pencairan pertama.