Bekerja sama dengan penulis teknis

Fase saat ini:
Program Dokumen Musim 2019 selesai pada 6 Maret 2020. Lihat linimasa.

Berikut beberapa pedoman untuk organisasi open source tentang cara bekerja sama dengan penulis teknis yang Anda bimbing untuk Season of Docs:

  • Perkenalkan penulis teknis ke dunia open source dan komunitas Anda.
  • Bantu penulis teknis menggunakan alat dan proses yang terlibat dalam berkontribusi ke project Anda.
  • Jelaskan produk 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.
  • Deskripsikan kebutuhan audiens—yaitu kebutuhan developer yang menggunakan produk Anda dan/atau kelompok lain yang menggunakan produk tersebut.
  • Lakukan workshop kasus penggunaan penting dengan penulis teknis untuk membantunya merancang dokumentasi yang diperlukan.
  • Telusuri kode saat penulis teknis perlu memahaminya sebelum menulis dokumen.
  • Membimbing penulis teknis menghubungi para pakar di bidang yang diperlukan. Yaitu, developer atau kontributor project lainnya yang bertanggung jawab atas aspek produk yang akan dicakup dalam dokumentasi.
  • Memastikan bahwa penulis teknis mendapatkan waktu dan referensi yang diperlukan dari pakar di bidangnya dan anggota komunitas lainnya.
  • Bekerja samalah dengan penulis teknis untuk menambahkan contoh kode yang bermakna ke dokumen jika relevan.

Hal-hal yang perlu diingat

Mentor open source di Season Dokumen tidak selalu berupa penulis teknis. Mentor tidak perlu memiliki keterampilan dokumentasi. Penulis teknis membawa keterampilan tersebut ke dalam proyek dan hubungan pembimbingan.

Sebaliknya, mentor membawa pengetahuan mereka tentang komunitas open source, produk, serta proses dan alat yang digunakan project open source.

Hasil penting dari hubungan bimbingan adalah bahwa penulis teknis memiliki pengalaman yang memuaskan dan sukses dalam Season Dokumen tahun ini. Pengalaman yang membahagiakan akan meningkatkan peluang bahwa penulis teknis akan terus berkontribusi pada project open source setelah Musim Dokumen tahun ini berakhir, dan penulis teknis lainnya akan antusias bekerja menggunakan open source.