Sabtu, 10 Maret 2012

DOKUMENTASI PROGRAM


       Kelemahan kita sebagai programer selama ini khususnya di Indonesia adalah tidak adanya dokumentasi/catatan kecil dalam pengembangan aplikasi, kalaupun ada hanya sekedarnya. Alasan yang paling utama adalah rasa  malas. Padahal dengan adanya dokumentasi, aplikasi yang kita kembangkan akan lebih rapi dan lebih mudah untuk pengembangan selanjutnya. Secara jujur kita selama ini tidak pernah mendokumentasikan aplikasi kita, jangankan koding punya orang lain , bahkan koding aplikasi kita sendiri yang kita buat 1-2 bulan yang lalu saja ketika akan kita ubah, kita pusing membaca koding kita sendiri, karena kita lupa. Oleh karena itu supaya lebih mempermudah kita memahami koding yang kita buat dan mempermudah orang lain, maka diperlukan dokumentasi yang bagus.

           Dokumentasi memang secara umum ada standarnya, namun sebenernya kalau boleh dibilang tata cara dokumentasi itu bebas, yang paling penting adalah mudah untuk dibaca kembali oleh kita maupun programer lain. Sistem dokumentasi yang paling ideal adalah menggunakan UML (Unified Modeling Language) dimana didalamnya banyak sekali diagram-diagram yang harus dibuat. Namun kita tidak akan mengadopsi seluruh diagram yang ada di dalam UML,kita akan gunakan 1,2 diagram saja. Yaitu Class Diagram dan Activity Diagram. 

           Untuk activity diagram bentuknya sama dengan SOP sebenernya, nanti akan kita gunakan jika ada kasus saja. Yang paling wajib kita gunakakan adalah Class Diagram, jika tata cara programing kita sudah mengadopsi OOP (Object Oriented Programming)

Software yang akan kita gunakan untuk membuat 2 diagram ini adalah :
  1. StarUML : bersifat free dan opensource, tata cara penggunaannya juga mudah, untuk mendownloadnya anda dapat menuju link ini.
  2. Microsoft Word : untuk penjelasan diagram-diagram yang kita buat.
1.      ACTIVITY DIAGRAM

Activity diagram sebenernya sangat mirip dengan diagram SOP. Didalamnya menjelaskan siapa saja yang berperan dan aktivitas apa yang dilakukan. Contohnya adalah perekaman customer baru.


   Diagram diatas menjelaskan tentang adanya 2 orang yang terlibat yaitu Customer dan Administrator. Sedangkan aktivitas yang dilakukan Cutomer adalah menyerahkan KTP ke Administrator lalu Administrator merekam datanya ke dalam aplikasi, selanjutnya mencetak kartu anggota dan menyerahkan kartu tersebut ke customer.

     2.  CLASS DIAGRAM
   
Kita tentu mengenal konsep ERD (Entity Relationship Diagram) yang isinya adalah relasi antar tabel. Class Diagram adalah penggambaran relasi/ hubungan antar kelas. Apakah kelas itu sejajar atau merupakan turunan dari kelas induknya. Diusahakan tiap tabel yang kita gunakan di dalam aplikasi memiliki kelas yang kita gunakan untuk mengakses data.

Contoh kita membuat 2 kelas yang mewakili 2 tabel, yaitu tabel departemen, dan tabel unit.


DEFINE CLASS KelasDep as Custom
      kddept=''        
      nmdept=''
     
      PROCEDURE p_caridept(ckd)
     
      ENDDEFINE

ENDDEFINE

DEFINE CLASS KelasUnit as KelasDep
     
      kdunit=''        
      nmunit=''
     
      PROCEDURE p_cariunit(ckddept,ckdunit)
           
      ENDDEFINE

ENDDEFINE

Gambar class diagramnya adalah :


Terlihat bahwa kelas unit tidak perlu kita definisikan lagi property kddept, sebab di kelas induk nya (KelasDepartemen) property kddept sudah di ada. Kelas Unit meliki panah keatas yaitu ke KelasDepartemen, hal ini menunjukkan bahwa KelasUnit adalah turunan dari Kelas Departemen. 









1 komentar: