Nama : Sukirno
Nim : 09410110021
Mata
Kuliah : Teknik
Dokumentasi Aplikasi
Dosen : Ayuningtyas,
S.Kom., M.MT., MOS
Teknik
Dokumentasi Aplikasi
Pentingnya Dokumentasi
Dokumentasi yang baik, tentu akan
berakibat baik terhadap perusahaan, kebaikan tersebut di lihat dari waktu dan
kefektifan karyawan baru untuk beradaptasi di perusahaan. Dengan dokumentasi
yang baik maka karyawan baru akan lebih cepat memahami apa yang
telah/sedang/akan mereka kerjakan, dengan membuat histori dokumentasi juga
menjadi nilai tambah untuk mengingat segala aktifitas perubahan pada proses
developmen sebuah aplikasi.
Berbeda
halnya apabila tidak mendokumentasikan setiap aktivitas perubahan, akan
berdampak tidak baik bagi perusahaan. Perusahaan akan memulai lagi Aplikasi
program baru dari nol, karena karyawan lama tidak mendokumentasikan segala
aktivitas/perubahan sedangkan karyawan baru tidak bisa menyesuaikan/melanjutkan
aplikasi program tersebut, kerugianpun akan dialami perusahaan. Oleh sebab itu
pembuatan dokumentasi sangatlah penting untuk menunjang sebuah pengembangan
aplikasi pada perusahaan.
Dokumentasi
Dokumentasi berasal dari kata dokumen
yang berarti bahan pustaka, baik berbentuk tulisan maupun berbentuk rekaman
lainnya seperti pita suara/kaset, video, film, gambar dan foto (Suyono trimo
1987, hal 7)
Contoh
Arsip:
a) Formulir
b)
Kartu Tanda Penduduk (KTP)
c)
Surat Ijin Mengemudi (SIM)
d)
Buku catatan pelajaran
e)
Buku pelajaran
f) Slip gaji
g)
Peta
h) Akte
kelahiran, dll.
Mengapa
beberapa contoh tersebut dapat dikatakan sebagai arsip?
-
Karena beberapa contoh yang telah disebutkan memiliki fungsi mengingatkan
tentang suatu hal
-
Buku catatan pelajaran contohnya, dapat digunakan untuk mengingat kembali bahan
pelajaran yang pernah didapat sehingga nantinya dapat dibaca kembali saat akan
menghadapi ujian.
Aplikasi
Aplikasi adalah suatu program komputer
yang dibuat untuk mengerjakan dan melaksanakan tugas khusus dari pengguna.
Aplikasi merupakan rangkaian kegiatan atau perintah untuk dieksekusi oleh
computer.
contoh
aplikasi:
a) Data
b) Audio
c) Grafik
d) Web
Designer
Dokumentasi aplikasi
Bisa Disimpulkan suatu program yang sudah di buat dan
disimpan di sebauh penyimpanan (dokumen) yang di urutkan sesuai urutanya .
Minimal,
ada 4 tingkat dokumentasi yang perlu di perhatikan yaitu:
1.
User Requirements, merupakan dokumen yang mencatat segala kebutuhan user yang
di inginkan. Hal ini cukup penting ketika ada komplain dari user, misal ketika
meminta penambahan fitur, menu dan lain sebagainya bisa di tunjukkan
kesepakatan awal yang di setujui.
2.
Architecture and Design, merupakan dokumen yang berisi desain atau rancangan
aplikasi, termasuk siapa saja pengguna yang terlibat dalam aplikasi. Bisa juga
di dalamnya di masukkan rancangan database (database design documentation).
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. Namun biasanya seorang programmer yang baik akan
menuliskan catatan/komentar pada coding yang di lakukannya. Hal ini berguna
untuk mengingatkan kembali proses coding yang di lakukan, jika nantinya perlu
untuk di buka kembali (di modifikasi/di tambah). Namun komentar yang banyak
pada file tentu akan menambah ukuran file sehingga di perlukan sebuah
dokumentasi teknis.
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.