Etersoul Journey

Di setiap keyboard pasti terdapat tombol F1. Tapi dari yang aku tahu banyak orang yang ga menekan tombol ini, karena kebanyakan bila menekan tombol ini dalam sebuah aplikasi salah-salah yang muncul adalah sebuah window yang dianggap “menganggu” dengan judul kurang lebih adalah “Help”. Padahal justru window yang mengganggu ini menjadi sebuah hal yang dapat membantu ketika kita pusing dalam menggunakan sebuah aplikasi.

Memang aku akui tidak semua orang suka membaca dokumentasi tertulis, dan lebih suka menanyakan orang lain secara langsung. Bahkan kalau sampai titik ekstrimnya sih bakal membuat orang lain kesal sendiri karena ditanya-tanya terus, padahal jawabannya dapat ditemukan di dokumentasi dengan sedikit usaha yaitu dengan Ctrl + F atau fungsi find. Tentu saja semua ini bukan hanya berlaku bagi penggunaan aplikasi, tetapi juga pengembangan aplikasi.

Kebanyakan software pengembangan aplikasi atau programming memiliki help file yang cukup membantu dan berisi daftar-daftar function dan cara penggunaan aplikasi tersebut. Bahkan untuk seseorang yang belum pernah menyentuh programming sama sekali, bisa saja dalam seminggu menjadi cukup mahir dalam dasar-dasar programming hanya dengan membaca help file dari awal bila orang tersebut benar-benar berniat pada programming atau pengembangan aplikasi. Percaya ga percaya bahwa hal ini memang nyata dan bukan cuma cuap-cuap kosong belaka.

(more…)

Ada sebuah paragraf yang dibuat oleh para programmer yang sekaligus penulis dokumentasi atas sebuah framework open source bernama CodeIgniter seperti di bawah ini.

Programmers love to code and hate to write documentation. We’re no different, of course, but since documentation is as important as the code itself, we are committed to doing it. Our source code is extremely clean and well commented as well.

Bila diterjemahkan ke Bahasa Indonesia, ungkapan itu kurang lebih berarti seperti di bawah ini:

Programmer suka menulis kode dan benci menulis dokumentasi. Kami juga tidak berbeda tentunya, tetapi karena dokumentasi sama pentingnya dengan kode itu sendiri, kami berkomitmen untuk melakukan itu (menulis dokumentasi). Source code kami sangat bersih dan terdokumentasi juga.

Dokumentasi di sini tidak hanya bererti menuliskan dokumentasi penggunaannya, melainkan dokumentasi atas kode yang dibuat programmer. Umumnya dokumentasi menggunakan comment block atau comment line untuk memisahkan dari kode utama. Sebagai contoh, comment block pada bahasa pemrograman C++ dan beberapa bahasa pemrograman lain adalah /* dan */, sedangkan comment line adalah //

(more…)