Fase saat ini:
Program Season of Docs 2021 berakhir pada 14 Desember 2021. Lihat
linimasa.
Berikut beberapa panduan untuk membantu organisasi open source bekerja secara efektif dengan penulis teknis.
Memperkenalkan penulis teknis ke dunia open source dan komunitas Anda
- Berikan 'tur terpandu' kepada penulis teknis di komunitas Anda. Di mana mereka dapat mengajukan pertanyaan? Rapat rutin apa yang harus mereka hadiri, atau milis apa yang harus mereka ikuti? Akun apa yang mereka perlukan (GitHub, Discord, Slack)? Pastikan mereka memahami kode etik project Anda, dan tahu cara melaporkan masalah apa pun. Pastikan penulis teknis Anda memahami lisensi proyek Anda, dan mematuhi setiap persyaratan dari pemberi kerja lain seputar penandatanganan CLA, DCO, atau perjanjian lainnya.
- Jika memungkinkan, perkenalkan mereka kepada beberapa orang di zona waktu yang tumpang-tindih yang dapat merespons dengan cepat pertanyaan tentang komunitas atau project.
- Jika Anda bisa, beri mereka beberapa suvenir proyek!
Membantu penulis teknis menggunakan alat dan proses yang terlibat dalam berkontribusi pada project Anda
- Jika proses Anda tidak didokumentasikan dengan baik, tentukan waktu untuk menjelaskan kontribusi, masalah, atau permintaan pull pertama mereka kepada penulis teknis. Template atau tag apa yang sebaiknya mereka gunakan? Siapa yang perlu meninjau kontribusi mereka, dan bagaimana serta kapan mereka harus menindaklanjuti peninjauan? Jika pekerjaan mereka menyertakan contoh kode, bagaimana cara mengujinya? Apa yang perlu mereka ketahui tentang rilis atau proses CI/CD Anda?
Membantu penulis teknis memahami proyek Anda dan para penggunanya
- Jelaskan proyek Anda secara rinci sehingga penulis teknis memperoleh pemahaman konseptual yang kuat tentang produk. Hal ini dapat membantu penulis teknis merasa lebih percaya diri dan lebih kredibel dalam menulis untuk project.
- Jelaskan kebutuhan orang-orang yang menggunakan project. Jelaskan sedetail mungkin—bukan hanya ‘pengembang’, tetapi ‘pengembang yang membuat situs web’ dan ‘pengembang yang memprogram robot industri’.
- Hubungi penulis teknis dengan pakar materi pokok yang diperlukan. Artinya, pengembang atau kontributor proyek lainnya bertanggung jawab atas aspek proyek Anda yang akan dibahas dalam dokumentasi.
- Pastikan penulis teknis mendapatkan waktu dan referensi yang mereka butuhkan dari pakar materi pelajaran dan anggota komunitas lainnya.
Ajukan pertanyaan!
- Komunitas atau proyek Anda mungkin tidak pernah bekerja sama dengan penulis teknis atau kontributor dokumentasi sebelumnya. Manfaatkan kesempatan untuk belajar sambil berbagi hal-hal yang Anda ketahui. Mintalah umpan balik tentang proses dan alat Anda—penulis teknis Anda mungkin akan memiliki beberapa saran untuk perbaikan.