Fase saat ini:
Pengembangan dokumentasi. Lihat
linimasa.
Berikut beberapa pedoman 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 bisa 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 project Anda, dan tahu cara melaporkan masalah apa pun. Pastikan penulis teknis Anda memahami lisensi project Anda, dan mematuhi semua persyaratan dari perusahaan lain seputar 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 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, siapkan waktu untuk memandu penulis teknis membahas kontribusi, masalah, atau permintaan pull pertamanya. Template atau tag apa yang harus mereka gunakan? Siapa yang perlu meninjau kontribusi mereka, dan bagaimana serta kapan mereka harus menindaklanjuti ulasan? Jika pekerjaan mereka menyertakan contoh kode, bagaimana pengujiannya? Apa yang perlu mereka ketahui tentang proses atau rilis CI/CD?
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. Buatlah sespesifik mungkin—bukan hanya 'developer', tetapi 'developer yang membuat situs web' dan 'developer memprogram robot industri'.
- Menghubungi penulis teknis dengan pakar materi pokok yang diperlukan. Yaitu, pengembang atau kontributor proyek lainnya yang bertanggung jawab atas aspek proyek Anda yang akan dicakup dalam dokumentasi.
- Pastikan penulis teknis mendapatkan waktu dan referensi yang diperlukan dari ahli materi pokok 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 masukan tentang proses dan alat Anda—penulis teknis Anda mungkin akan memiliki beberapa saran untuk perbaikan.