Fase saat ini:
Program Dokumen Season 2021 selesai pada 14 Desember 2021. Lihat
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 mencari penulis teknis mereka sendiri. Penulis teknis yang tertarik untuk bekerja sama dengan organisasi yang berpartisipasi dalam Season Dokumen dapat ditemukan di season of Docs GitHub repo, dan di channel#season-of-docs dalam Write the Docs Slack.
Menilai seorang penulis teknis
Sebaiknya Anda meminta contoh dokumentasi yang dikembangkan sebelumnya dari penulis teknis yang Anda pertimbangkan, sehingga Anda dapat berfokus pada 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 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?