Fase saat ini:
Program Dokumen Musim 2019 selesai pada 6 Maret 2020. Lihat
linimasa.
Halaman ini berisi pedoman untuk organisasi open source tentang cara menilai proposal project penulisan teknis dan memilih project yang ingin mereka bimbing di Season Dokumen.
Pengantar
Penulis teknis mengirimkan proposal Season of Docs untuk mengerjakan project dengan organisasi open source pilihan mereka. Administrator program Google meneruskan proposal ke organisasi open source untuk penilaian dan pemilihan project. Untuk mengetahui detail langkah-langkah yang diperlukan, lihat panduan administrator organisasi.
Menilai proposal penulis teknis
Keterampilan dan pengalaman menulis teknis
Periksa pengalaman sebelumnya dari penulis teknis. Proposal penulis teknis menyertakan informasi tentang pengalaman penulisan teknis terbaru mereka. Idealnya, pelamar 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 proposal penulis teknis dari sudut pandang ini. Yang paling penting: Bisakah Anda memahami apa yang ditulis orang itu? Sebagai mentor, Anda berperan membantu penulis teknis mengenai proses, alat, dan kode {i>open source<i}. Anda tidak perlu meninjau teks dokumentasi yang dihasilkan. Jika Anda ingin melakukan peninjauan mendalam terhadap bahasa proposal, 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. Sebagai bagian dari proposal, penulis teknis memiliki kesempatan untuk memberikan contoh dokumentasi yang telah mereka kembangkan. 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?
Proposal
Periksa apakah proposal sesuai dengan persyaratan Anda. Apakah proposal ini terkait dengan salah satu ide project yang Anda kirimkan untuk Musim Dokumen tahun ini? Jika penulis teknis telah mengusulkan ide baru, periksa apakah proposal tersebut sesuai dengan kebutuhan project open source Anda, dan Anda memiliki orang yang tepat untuk membantu penulis teknis mencapai tujuan project yang diusulkan.
Cari antusiasme dan ketelitian. Apakah proposal menunjukkan bahwa penulis teknis bersemangat dengan proyek tersebut? Pertimbangkan apakah mereka telah memikirkan dan mengolah proposal, baik dengan berkonsultasi dengan organisasi Anda selama fase eksplorasi, atau dengan menambahkan pemikiran mereka sendiri tentang cara mencapai sasaran project.
FAQ
Bagaimana kami menentukan berapa banyak proyek yang akan dikirimkan?
Berfokuslah pada satu atau dua proyek. Jika organisasi Anda memiliki kapasitas untuk membimbing lebih dari itu, Anda dapat mengirimkan lebih banyak lagi. Untuk setiap proyek penulis teknis, Anda memerlukan setidaknya satu mentor (sebaiknya dua) yang berkomitmen untuk membimbing proyek tersebut saja.
Baca informasi tentang cara kerja alokasi slot Season Dokumen.
Bagaimana cara memilih proposal penulisan teknis yang akan diterima?
Pastikan Anda memilih proposal penulis teknis terbaik yang telah diterima. Artinya, pilih proposal yang paling sesuai dengan persyaratan Anda, dan yang paling sesuai dengan pedoman penilaian yang tercantum di atas.