Fase saat ini:
Hasil diumumkan. Lihat
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 mereka hadiri, atau milis apa yang harus mereka ikuti? Akun apa yang mereka butuhkan (GitHub, Discord, Slack)? Pastikan mereka memahami kode etik proyek, dan tahu cara melaporkan masalah apa pun. Pastikan penulis teknis Anda memahami lisensi proyek Anda, dan mematuhi persyaratan apa pun 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 menjawab pertanyaan tentang komunitas atau proyek dengan cepat.
- Jika Anda bisa, kirimkan beberapa suvenir proyek kepada mereka!
Bantu penulis teknis menggunakan alat dan proses yang terlibat untuk berkontribusi pada proyek Anda
- Jika proses Anda tidak terdokumentasi dengan baik, persiapkan waktu untuk memandu penulis teknis mengenai kontribusi, masalah, atau permintaan pull pertama mereka. Template atau tag apa yang harus mereka gunakan? Siapa yang perlu meninjau kontribusi mereka, serta bagaimana dan kapan sebaiknya mereka menindaklanjuti ulasan? Jika pekerjaan mereka menyertakan contoh kode, bagaimana caranya? Apa yang perlu mereka ketahui tentang proses atau rilis CI/CD Anda?
Membantu penulis teknis memahami proyek Anda dan penggunanya
- Jelaskan proyek Anda secara detail sehingga penulis teknis mendapatkan pemahaman konseptual yang kuat tentang produk tersebut. Hal ini dapat membantu penulis teknis merasa lebih percaya diri dan lebih otoritatif dalam tulisannya untuk proyek tersebut.
- Jelaskan kebutuhan orang-orang yang menggunakan proyek. Jelaskan sespesifik mungkin—bukan hanya 'developer' tetapi 'developer yang membuat situs web' dan 'developer pemrograman robot industri'.
- Menghubungi penulis teknis dengan pakar materi pokok yang diperlukan. Yaitu, pengembang atau kontributor proyek lainnya bertanggung jawab atas aspek-aspek proyek Anda yang akan dicakup dalam dokumentasi.
- Pastikan penulis teknis mendapatkan waktu dan sumber daya yang dibutuhkan dari pakar bidang tertentu dan anggota komunitas lainnya.
Ajukan pertanyaan!
- Komunitas atau project Anda mungkin belum pernah bekerja sama dengan penulis teknis atau kontributor dokumentasi. Manfaatkan kesempatan untuk belajar sambil membagikan apa yang Anda ketahui. Mintalah umpan balik tentang proses dan {i>tool<i} Anda—penulis teknis Anda mungkin akan memiliki beberapa saran untuk perbaikan.