Mata Kuliah : Teknik Dokumentasi Aplikasi
Dosen : Ayuningtyas, S.Kom., M.MT., MOS
Teknik Dokumentasi Aplikasi
I.
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
II.
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.
III.
Software Crisis
Software
Crisis dapat terjadi karena ketidak mampuan membangu proyek. pembuatan suatu
software yang diinginkan karena beberapa masalah seperti berikut ini :
a.
Melebihi batas waktu
b.
Melebihi anggaran/biaya
c.
Software tidak efisien
d.
Software tidak memiliki kualitas yang bagus
e.
Tidak memenuhi persyaratan
f.
Proyek sulit dikendalikan
Sumber : Link
IV.
Dokumentasi Aplikasi meliputi elemen-elemen sebagai berikut :
1.
Requirements Documentation
2.
Architecture & Design Documentation
3.
Technical Documentation
4.
End User Manuals Documentation
a)
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.
b)
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).
c)
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.
d)
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.
- Kapan membuat Dokumentasi
Membuat dokumentasi
pada saat melakukan segala aktivitas/perubahan yang terjadi ketika proses
developmen sebuah aplikasi untuk sebuah perusahaan.
- 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.
Sumber : Link
