Tahap saat ini:
Hasil diumumkan
linimasa.
Berikut beberapa panduan untuk membantu organisasi open source bekerja secara efektif dengan penulis teknis.
Perkenalkan penulis teknis ke dunia open source dan komunitas Anda
- Berikan 'tur terpandu' kepada penulis teknis tentang komunitas Anda. Di mana mereka dapat mengajukan pertanyaan? Pertemuan rutin apa yang harus dia hadiri, atau milis apa yang harus mereka ikuti? Akun apa yang mereka perlukan (GitHub, Discord, Slack)? Pastikan mereka memahami kode etik proyek Anda, dan tahu cara melaporkan masalah apa pun. Pastikan penulis teknis Anda memahami lisensi proyek Anda, dan mematuhi persyaratan apa pun dari perusahaan lain seputar penandatanganan CLA, DCO, atau perjanjian lainnya.
- Jika memungkinkan, perkenalkan mereka kepada beberapa orang yang berada di zona waktu yang sama, yang dapat menjawab pertanyaan tentang komunitas atau proyek dengan cepat.
- Jika Anda bisa, kirimkan beberapa suvenir proyek!
Bantu penulis teknis menggunakan alat dan proses yang terlibat dalam berkontribusi pada proyek Anda
- Jika proses Anda tidak terdokumentasi dengan baik, luangkan waktu untuk memandu penulis teknis mengenai kontribusi, masalah, atau permintaan pull pertama mereka. Template atau tag apa yang sebaiknya mereka gunakan? Siapa yang perlu meninjau kontribusinya, serta bagaimana dan kapan seharusnya ulasan tersebut ditindaklanjuti? Jika pekerjaan mereka menyertakan contoh kode, bagaimana mereka bisa diuji? Apa yang perlu mereka ketahui tentang proses atau rilis CI/CD Anda?
Membantu penulis teknis memahami proyek Anda dan penggunanya
- Jelaskan proyek Anda secara rinci sehingga penulis teknis mendapatkan pemahaman konseptual yang kuat tentang produk tersebut. Hal ini bisa membantu penulis teknis merasa lebih percaya diri dan lebih otoritatif dalam tulisannya untuk proyek tersebut.
- Jelaskan kebutuhan orang-orang yang menggunakan proyek. Jelaskan sedetail mungkin—bukan hanya 'pengembang' tetapi juga 'pengembang yang membuat situs web' dan 'pengembang yang memprogram robot industri'.
- Membimbing penulis teknis menghubungi para pakar di bidang yang diperlukan. Yaitu, pengembang atau kontributor proyek lainnya yang bertanggung jawab atas aspek proyek Anda yang akan dicakup dalam dokumentasi.
- Memastikan bahwa penulis teknis mendapatkan waktu dan sumber daya yang mereka butuhkan dari para pakar di bidangnya dan anggota komunitas lainnya.
Ajukan pertanyaan!
- Komunitas atau proyek Anda mungkin belum pernah bekerja sama dengan penulis teknis atau kontributor dokumentasi. Manfaatkan kesempatan ini untuk belajar sambil membagikan apa yang Anda ketahui. Mintalah umpan balik tentang proses dan alat yang Anda gunakan—penulis teknis Anda kemungkinan akan memiliki beberapa saran untuk perbaikan.