Home > IT News > Dokumentasi Aplikasi Merupakan Hal yang Penting

Dokumentasi Aplikasi Merupakan Hal yang Penting

Bagi saya, seorang programmer “mungkin” dokumentasi merupakan hal yang menjadi prioritas yang paling akhir. Karena menurut saya urutan yang harus diprioritaskan adalah :

  1. Tidak ada eror😀, kenapa?Karena eror merupakan momok bagi seorang programer, yaitu eror sebelum compile atau intepreting, eror runtime atau debugging, dan juga eror logic. Karena dengan eror programmer akan pusing 7 keliling untuk melakukan googling agar eror itu teratasi😉
  2. Output benar?Biasa terjadi saat ujicoba sama user, yang penting tampilan bener, masalah masih hardcode, ataupun penggunaan logic sementara bisa dilakukan untuk mengatasi masalah ini.
  3. Proses perhitungan atau bisnis logic sesuai dengan kaidah yang ditentukan. setelah semua eror diatasi, barulah seorang programmer berfikir, bagaimana aplikasinya ini benar-benar berjalan sesuai dengan kaidah yang ada. agar tidak eror melulu😉 biasanya pada tahapan ini programmer mulai berfikir jangka panjang. pada tahapan inilah yang disebut “cuci tangan”😀. Membersihkan diri dari dosa-dosa membuat hardcode atau penggunaan logic sementara.
  4. Optimalisasi coding. pada tahapan ini, programmer sudah melihat aplikasinya berjalan sesuai yang diharapkan. dan mulai berfikir bagaimana proses dapat berjalan lebih cepat. ada beberapa alternatif seperti perbaikan logic agar lebih singkat dan efektif, perbaikan infrastuktur dan jaringan dan.
  5. Dokumentasi, the last but not the least. dokumentasi seperti “mayat hidup” yang kembali bangkit disaat yang tidak tepat😀.

Disaat programmer melihat aplikasi sudah berjalan lancar, sudah bisa menikmati relaksasi otak yang di peras sepanjang pengembangan aplikasi. tiba saatnya AUDIT >:). mendengar kalimat ini, mungkin seperti Alice melihat para zombie keluar dari sarang pada film resident evil😀. what i have to do… banyak bro, seperti yang dikutip dari blog http://ci-muetz.blogspot.com/2010/05/membuat-dokumentasi-program.html.

Dokumentasi Program adalah catatan mengenai program yang telah dirancang. dapat meliputi catatan tentang tujuan program. data yang dipergunakan dalam program, logika yang dipergunakan. bentuk input/output serta cara menggunakan programnya.

Dokumentasi program diperlukan untuk tujuan :

  1. petunjuk untuk mereka yang akan menggunakan program
  2. sebagai bahasa training di dalam penerapan program
  3. Di dalam pemeliharaan program. bila akan memodifikasi atau mengembangkan program lebih lanjut akan lebih mudah bila tersedia dokumentasinya
  4. mempermudah mencari dan membetulkan kesalahan-kesalahan program yang terjadi
  5. sebagai hard copy dari program yang dapat berfungsi untuk backup dari program. bila program yang tersimpan di simpanan luar rusak atau terhapus atau hilang , bila mempunyai dokumentasinya akan lebih mudah untuk dirancang untuk dibuat tanpa harus memikirkan ulang kembali.

Dokumentasi program dapat berupa

  1. keterangan penjelaskan (narrative description) yang berisi keterangan-keterangan program. data yang dibutuhkan, prosedur-prosedur , bentuk-bentuk input, output, tanggal dibuat. sifat dan program dan informasi-informasi yang berguna bagi mereka yang berhubungan dengan program tersebut.
  2. hasil dari perencanaan program, dapat berbentuk :
    1. Pseudocode
    2. Stuctured chart
    3. Program flow-chart
  3. Cetakan dari program sumber (source program listing)
  4. Manual operasi penggunaan program

Referensi : Pengenalan Komputer
Pengarang : Prof.Dr.Jogiyanto H.M, M.B.A., Akt

Wow banyak juga, kebetulan saat ini saya memang diminta dari klien untuk membuat dokumentasi dalam bentuk laporan yang komplet dan auditabel?

wah bingung langsung, selama menjadi programmer, saya belum pernah membuat dokumentasi seformil itu? akhirnya back to google, cari-cari sana sini. akhir ketemu metode bagaimana membuatnya, tapi lupa lagi link nya.

kerangka yang dibuat sebagai berikut :

  1. Overview sejenak apakah aplikasi ini? Digunakan untuk apa saja? Gambaran general aplikasi ini akan digunakan?
  2. Overview spesifik aplikasi ini akan digunakan, hingga pihak yang akan terkait.
  3. Arsitektur Komputer baik secara global seluruh perusahaan maupun spesifik yang terkait dengan sistem.
  4. Flow data yang mengalir dari mulai aplikasi digunakan hingga selesai. disini saya gambarkan dengan flowchart, agar mudah orang awal dengan semua disiplin ilmu memahami. tapi kalau mau menggunakan tool analisa lain seperti UML,DFD,ERD dll boleh juga.
  5. Security, disini saya gambarkan pengamanan yang dilakukan untuk mengamankan data. baik dari sisi hardware,jaringan dan software.
  6. Definisi yang digunakan, karena dokumentasi mungkin dibaca oleh orang non IT, saya buatkan definisi-definisi kalimat yang saya anggap asing.
  7. Penggunaan aplikasi.

well dokumentasi sudah jadi, yang masih saya waspadai sekarang masalah tata bahasa yang saya masukan kedalam dokumentasi tersebut, karena akan digunakan oleh pihak luar dan akan diaudit suatu saat nanti.  Berhubung lebih sering pakai bahasa pemrograman dibanding pakai bahasa indonesia😀.

loh kok bisa begitu? coba saja hitung.

  1. Dikantor kerja 8-10 jam, kebanyakan ngoding😀
  2. Tidur 8-9 jam,kebo kali ya😀
  3. Sisa 5-8 jam, dirumah kadang masih ngoding,maen game atau nonton tv yang berujung pada gk pake bahasa indonesia

jadi kesimpulan lebih sering pake bahasa pemrograman😀

sekian sharing saya, mohon maaf jika ada kesalahan kata. semoga bermanfaat.

EL_ZALMAN’s

Categories: IT News
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: