RESUME Pertemuan
1 TEKNIK DOKUMENTASI APLIKASI
Pengertian
Dokumen dalam Teknologi Komputer:
·
Hardcopy
(salinan dokumen dalam bentuk cetak) dan Softcopy (salinan berupa elektronik).
·
Dokumentasi
menyimpan deskripsi tertulis sebuah program termasuk nama program, fungsi
program, masukan/keluaran yang dibutuhkan, kemungkinan ditulis dalam algoritma,
bagaimana struktur datanya.
·
Document
Per Minute (DPM), jumlah data yang diproses dalam satu menit.
·
Document
Root, sebuah direktori dalam file system web server yang merupakan pangkat dari
file-free untuk semua dokumen yang tersedia.
·
Extention,
perpanangan, perluasan (nama akhiran berkas digunakan untuk menandakan isi atau
format dari berkas), misalnya: doc, gif, jpg, pdf, ppt, txt, zip.
Pembuatan dokumentasi dapat membawa
banyak manfaat bagi para pengembang
perangkat lunak. Dokumentasi dapat mengefisienkan waktu dari
perancangan, pembuatan, pengetesan dan
pemanfaatan sebuah perangkat lunak. Sayangnya banyak para
pengembang yang mengabaikan kualitas dari dokumentasi perangkat
lunak.
Ada 4
tingkat dokumentasi yang perlu di perhatikan yaitu :
1. User Requirements, merupakan
dokumen yang mencatat segala kebutuhan user yang di inginkan
2. Architecture and Design,
merupakan dokumen yang berisi desain atau rancangan aplikasi.
3. Technical documentation,
merupakan dokumen yang berisi segala hal catatan penting di coding/skrip
pemrograman/bahasa pemrograman yang di pakai, bisa juga query yang di gunakan.
4. End user manual, merupakan
dokumen yang di peruntukkan untuk user/konsumen/ yang akan menggunakan
aplikasi, selain itu untuk user juga di perlukan komunikasi verbal sehingga
mereka dapat menggunakan aplikasi secara optimal.
Beberapa
permasalahan yang sering terjadi dalam pendokumentasian aplikasi antara lain:
- Dokumentasi software ternyata tidak lengkap, ada bagian penting dari software yang tidak dijelaskan dengan cukup, sehingga sulit untuk memahaminya.
- Format dan struktur dokumen berbeda-beda
- Cara pemodelan berbeda-beda. Mungkin ada yang masih menggunakan flowchart + ER Diagram saja, ada yang menambahkan Data Flow Diagram (DFD), ada yang mencampur adukan UML dengan DFD, atau ada yang secara penuh sudah menerapkan UML.
Permasalahan-permasalahan
tersebut di atas akan menghambat tujuan-tujuan sebagai berikut:
- Melakukan modifikasi software menjadi sulit dilakukan.
- Melakukan pengembangan lebih lanjut menggunakan vendor lain.
- Melakukan integrasi dengan aplikasi lain.
Sumber
:
