Pentingnya Dokumentasi Dalam Pemrograman

Bagikan

Apakah kamu tim menulis dokumentasi dari code program yang sudah kamu buat? Ataukah bahkan kamu tidak pernah menulis dokumentasi apapun pada programmu?

Well, ternyata membuat dokumentasi dalam pemrograman itu penting loh.

Mungkin kadang kita tidak sempat untuk menulis dokumentasi ataupun terlihat seperti tidak membutuhkan dokumentasi.

Namun dibalik itu semua jika kamu membuka code-code lama mu atau saat kamu membutuhkan suatu code yang sebenarnya kamu pernah buat dimasa lampau kegunaan dokumentasi sangat terasa.

Yuk simak artikel dibawah ini yang akan membahas pentingnya dokumentasi dalam pemrograman.

 

Manfaat dokumentasi dalam pemrograman :

1. Untuk review kode yang ditulis setahun atau beberapa bulan yang lalu

Kemungkinan sangat besar kita sering membuka codingan kita yang lalu, dan kita lupa code yang kita buat ini untuk apa. Dengan adanya dokumentasi tentu akan membuat kita ingat program-program lama kita serta code yang telah kita buat.

2. Menyediakan kode untuk digunakan orang lain

Dokumentasi mempermudah kita untuk share code yang sudah kita buat. Tentu jika kita membuat dokumentasi akan memudahkan orang lain memahami code yang kita buat.

3. Membantu programmer yang membutuhkan

Dokumentasi juga bisa kita lakukan dengan share codingan kita ke github ataupun gitlab. Tentu akan membantu programmer lain bukan?

4. Melatih menulis kode dengan baik

Secara tidak sadar dengan membuat dokumentasi kita menulis code juga akan lebih rapih

Macam dokumentasi program

Dokumentasi spesifikasi program

Dokumentasi spesifikasi program seharusnya sudah ada sebelum program dibuat. Dibuat oleh perancang aplikasi (sering kali dibuat oleh analis sistem).

Berdasarkan dokumentasi inilah program dibuat.

Dokumentasi spesifikasi program ini dibuat untuk memberikan panduan tentang logika program yang harus dibuat.

Harus ada proses apa saja, bagaimana flow prosesnya. Pemrogram dapat melakukan coding dengan lebih mudah.

Akan tetapi, sering terjadi, dokumentasi spesifikasi program tidak dibuatkan oleh perancang aplikasinya.

Perancang aplikasi hanya menjelaskan tentang program, spesifikasi program yang ada adalah spesifikasi secara lisan.

Akibatnya adalah seringkali program tidak sesuai dengan yang diinginkan, karena pemrogram bekerja dengan mengandalkan ingatannya, bukan berdasarkan panduan dokumen spesifikasi.

Ketiadaan dokumentasi bisa menyebabkan komunikasi antara perancang aplikasi dan pemrogram menjadi tidak baik, karena bisa jadi akan ada perselisihan akibat ketidakjelasan akan apa yang dikerjakannya.

Dokumentasi Kode Program

Dokumentasi kode program, merupakan dokumentasi yang harus ada dalam program, untuk memberikan penjelasan kepada setiap baris maupun blok perintah dalam program.

Dokumentasi program diperlukan bagi programmer itu sendiri, untuk dapat menelusuri logika program.

Karena biasanya, pemrogram akan lupa akan alur programnya sendiri. Apalagi jika sudah lama sudah ditinggalkan, karena mengerjakan pekerjaan lain.

Pada saat harus memperbaiki atau menyempurnakan, programmer sering harus mempelajari terlebih dahulu alur programnya sendiri, baru kemudian baru bisa melakukan modifikasi sesuai dengan yang diinginkan.

Dari sisi lain, dokumentasi juga diperlukan untuk memudahkan untuk memvalidasi apakah program yang telah dikembangkan, sudah sesuai dengan yang dispesifikasikan atau belum.

Proses validasi ini akan dilakukan oleh tim penguji (validator).

Dokumentasi kode program merupakan pelengkap dokumentasi spesifikasi, karena menjelaskan bagaimana dari spesifikasi diterjemahkan ke dalam program.

Isi dari dokumentasi kode program, setidaknya terdiri atas:

  • langkah-langkah dalam program untuk menyelesaikan masalah
  • komentar dituliskan pada setiap awal modul atau fungsi,
  • jika mungkin komentar ditulis pada setiap blok program, jika tidak maka ditulis pada blok-blok yang penting saja. Lebih baik lagi jika setiap baris ada komentarnya.
  • Informasi tentang siapa yang membuat, kapan pertamakali dibuat, kapan terakhir diperbaiki, jika mungkin informasi perubahan dari waktu ke waktu

Cara menuliskan komentar harus mengikut kepada cara penulisan yang baku. Jika menggunakan bahasa pemrograman Java, maka dapat menggunakan format yang telah ditetapkan oleh javadoc.

Dokumentasi Penggunaan Program

Dokumentasi penggunaan program sangat diperlukan untuk dapat memberitahu kepada pengguna bagaimana cara menggunakan program yang telah dibuat.

Jika tidak dibuatkan cara menggunakan programnya, dikhawatirkan program menjadi tidak dapat dipakai, apalagi jika programnya kurang interaktif.

Banyak program yang dibuat, cara pemakaiannya sesuai dengan alur logika pemrogramnya.

Bukan berdasarkan alur logika pengguna program. Karenanya harus dibuatkan dokumentasi cara menggunakan program, agar pengguna tahu bagaimana cara menggunakan dengan benar.

 

Semoga artikel ini bermanfaat yaa

Subscribe & Dapatkan Info Lainnya

WEBZID DEVELOPER

Berita Terkait