Teknik Dokumentasi
Aplikasi
Dokumentasi Software
Software Documentation
adalah teks tertulis yang menyampaikan isi perangkat lunak komputer. Software
Documentation menjelaskan bagaimana mengoperasikan atau menggunakan software
tersebut dan dapat menjelaskan hal-hal penting lainnya terhadap user yang
membacanya.
Crisis Software
Software Crisis adalah
istilah yang digunakan dalam ilmu komputer untuk menggambarkan dampak
kompleksitas masalah dalam kemampuan komputer itu bekerja. Istilah ini pada
intinya, mengacu pada kesulitan menulis kode yang benar, pemahaman rancangan
yang sesuai dengan kebutuhan, dan dapat diverifikasi program komputer sesuai
dengan platform komputer yang memadai.
Penyebab Software
Crisis bisa bermacam-macam.
Contohnya :
- Proyek berjalan
membutuhkan anggaran yang melebihi dari apa yang dianggarkan.
- Proyek berjalan
melebihi waktu yang dianggarkan.
- Software tidak sesuai
dengan yang dibutuhkan dan memiliki kualitas yang rendah.
- Tidak ada pengendali
error sehingga membuat program sulit terkendali.
- Software tidak dapat
dijangkau oleh User yang bebas(awam)
Pentingnya Dokumentasi
Software
Buge Satriono Lelono
dalam tulisannya mengenai pentingnya dokumentasi dalam IT atau pembuatan
Software menjelaskan bahwa dokumentasi sebagai pendukung pengembangan sistem.
Beliau menjelaskan menurut pengalamannya bagaimana pentingnya Dokumentasi dalam
pembuatan Sotware. Berikut Penjelasannya :
“Dari
berbagai literatur dan sumber-sumber informasi lainnya, bisa disimpulkan bahwa
Software Engineer/System Application Documentation, meliputi elemen-elemen
sebagai berikut di bawah ini:
- Requirements Documentation
- Architecture & Design
Documentation
- Technical Documentation
- End User Manuals Documentation
Elemen ke dua, yakni Architecture & Design
Documentation, meliputi Database Design Documentation atau DDD. Sedangkan
Technical Documentation, meliputi coding/scripting/querying documentation
(tujuan, deskripsi, algoritma, API & class yang digunakan - kalau
ada, Query yang digunakan, dan database yang digunakan).
Mengapa hal tersebut di atas menjadi begitu penting?
Baiklah, saya memberi contoh sederhana saja, dari pengalaman saya sendiri
(pengalaman konyol karena mengabaikan dokumentasi). Pernah suatu ketika saya
bekerja di sebuah perusahaan, seorang programmer mendadak mengundurkan diri. Awalnya
tentu tidak masalah buat saya, mengingat bahwa aplikasi yang dibuatnya
kebetulan memang sangat stabil, termasuk berbagai urusan dengan end-user yang
menyangkut “bug handling”. Yang kemudian menjadi masalah besar adalah, ketika
perusahaan atau manajemen, mengubah kebijakan teknis yang tentunya bertujuan
untuk efesiensi biaya yang efeknya juga merembet pada keharusan me-modifikasi
aplikasi berbasis komputer.
Tentu saja saya kelabakan, meskipun elemen pertama dan
kedua sudah terdokumentasi, namun elemen ke tiga, Technical Documentation sama
sekali tidak saya miliki dan memang ketika itu saya abaikan, atau lebih
tepatnya, saya anggap sepele. Ujung-ujungnya ya kerja bakti, sambil
mencari-cari programmer pengganti. Saat itu pun saya sudah bisa memprediksi, secanggih
apa pun programmer pengganti, tanpa Technical Documentation yang tersusun baik
dan benar, pasti akan membutuhkan waktu lama agar dapat “tune in” untuk urusan
pengembangan aplikasi. Artinya, apabila “cost & effectiveness” juga
diperhitungkan, maka waktu yang terbuang akibat Technical Documentation yang
tidak tersedia, jelas sangat merugikan perusahaan.”
Kesimpulan
Kesimpulannya adalah
dalam pengembangan aplikasi,Dokumentasi itu hal yang penting dan tidak boleh
diremehkan. Karena dengan adanya dokumentasi dapat menjelaskan bagaimana
program itu, apakah kelemahan program itu, atau bagaimana cara menjalankan
program itu kepada user. Selain itu, dapat juga memudahkan user jika user akan
mencoba memodifikasi aplikasi tersebut.
Terima Kasih Atas Perhatiannya..