Halaman ini diterjemahkan oleh Cloud Translation API.

Bekerja sama dengan penulis teknis

Fase saat ini:
Studi kasus dipublikasikan. Lihat linimasa.

Berikut beberapa panduan untuk membantu organisasi open source bekerja secara efektif dengan penulis teknis.

Berikan 'tur terpandu' komunitas Anda kepada penulis teknis. 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 mengetahui cara melaporkan masalah apa pun. Pastikan penulis teknis Anda memahami lisensi project Anda, dan mematuhi persyaratan apa pun dari pemberi kerja lain terkait penandatanganan CLA, DCO, atau perjanjian lainnya.
Jika memungkinkan, perkenalkan mereka kepada beberapa orang di zona waktu yang tumpang-tindih yang dapat merespons pertanyaan tentang komunitas atau project dengan cepat.
Jika memungkinkan, kirimkan beberapa merchandise project kepada mereka.

Jika proses Anda tidak didokumentasikan dengan baik, tentukan waktu untuk menjelaskan kontribusi, masalah, atau permintaan pull pertama penulis teknis. Template atau tag apa yang sebaiknya digunakan? 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 proses atau rilis CI/CD Anda?

Jelaskan project Anda secara mendetail sehingga penulis teknis mendapatkan pemahaman konsep 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. Buat sedetail mungkin—bukan hanya 'developer', tetapi 'developer yang membuat situs web' dan 'developer yang memprogram robot industri'.
Hubungi penulis teknis dengan pakar materi pokok yang diperlukan. Artinya, developer atau kontributor project lainnya yang bertanggung jawab atas aspek project Anda yang akan dicakup dalam dokumentasi.
Pastikan penulis teknis mendapatkan waktu dan sumber daya yang mereka butuhkan dari para pakar materi pelajaran dan anggota komunitas lainnya.

Komunitas atau project Anda mungkin belum pernah bekerja sama dengan penulis teknis atau kontributor dokumentasi sebelumnya. Manfaatkan peluang untuk belajar saat Anda membagikan hal-hal yang Anda ketahui. Minta masukan tentang proses dan alat Anda—penulis teknis Anda kemungkinan akan memiliki beberapa saran untuk peningkatan.