Ketika saya masih pemula dalam menggunakan Unix dan menjadi programer, jawaban yang sering digunakan untuk pertanyaan teknologi adalah RTFM, yang berarti “Baca Manualnya yang Bagus.” Namun, hal ini tidak berubah untuk para pengguna Linux dan perangkat lunak open-source. Sudah waktunya kita mengatasi masalah ini dan membawa perubahan positif. Manual dan hampir semua dokumentasi sering kali sudah kadaluarsa, terkadang sulit untuk dibaca, dan terkadang, bahkan tidak ada.
Tidak adil. Beberapa orang telah bekerja keras pada dokumentasi. Hanya saja, tidak cukup banyak dari mereka, dan orang-orang yang telah bekerja pada hal tersebut sudah kelelahan.
Benar, Alejandro Colomar, yang telah memelihara proyek man-pages Linux selama empat tahun terakhir, baru saja berhenti. Mengapa? Sangat sederhana, Colomar menjelaskan, “Saya telah melakukannya di waktu luang saya, dan tidak ada perusahaan yang mensponsori pekerjaan itu sama sekali. … Saya tidak bisa lagi bertahan secara ekonomi untuk melakukan pekerjaan ini.”
Siapa yang bisa menyalahkan dia?
Steve Rostedt, seorang insinyur perangkat lunak Google dan pengembang kernel Linux, akan setuju. Pada konferensi Linux Plumbers tahun lalu, dia mengatakan, “ketika dia menemui bug, dia tidak bisa menemukan dokumen yang menjelaskan bagaimana cara kerjanya.” Jika seseorang se experienced Rostedt mengalami kesulitan, seberapa banyak keberuntungan menurut Anda seorang pemrogram pemula akan mencoba menemukan jawaban atas pertanyaan yang sulit?
Terlalu banyak proyek GitHub, misalnya, hanya memiliki file README untuk dokumentasi. Itu tidak membantu.
Jadi, apa yang bisa kita lakukan tentang ini? OpenSource.com memiliki daftar praktik terbaik dokumentasi.
Nilai kontribusi pada dokumentasi sama pentingnya dengan kontribusi kode.
Pasang dokumentasi dan kode dalam repositori proyek yang sama.
Jadikan dokumentasi sebagai persyaratan untuk pencapaian atau rilis.
Miliki proses kontribusi yang konsisten untuk kode dan dokumentasi.