NIM : 10.41011.0011
Nama : Relina Ayudhia
MK : Teknik Dokumentasi Aplikasi (TDA)
PROSES DOKUMENTASI APLIKASI
Pada proyek
software yang besar, beberapa dokumen biasanya telah dihasilkan bahkan sebelum
proses pengembangan/pembuatan dimulai. Seperti adanya proposal untuk pembuatan sistem/software
tertentu sebagai jawaban dari permintaan klien ataupun strategi bisnis.
Berikutnya adalah dokumen requirement yang komprehensif yang mendefinisikan
fitur-fitur yang dibutuhkan atau perilaku sistem yang diharapkan dari suatu sistem.
Selama proses pengembangan sendiri, ada banyak jenis dokumen yang dapat
dihasilkan, rencana proyek, spesifikasi desain, rencana pengetesan, dan
lain-lain. Beberapa dokumen yang diproduksi dalam proyek dapat dikategorikan
dalam 2 kelas yang berbeda yaitu:
1.
Dokumentasi
proses
Dokumen-dokumen
ini merekam proses pengembangan dan maintenance. Rencana-rencana,
jadwal-jadwal, dokumen kualitas proses, standar organisasi dan standar proses
merupakan dokumentasi proses.
2.
Dokumentasi
produk
Dokumentasi
ini menggambarkan produk yang sedang dikembangkan. Dokumentasi sistem
menjelaskan produk dari sudut pandang teknis dalam mengembangkan dan memelihara
sistem. Dokumentasi user menyediakan penjelasan produk yang berorientasi pada
user. Dokumentasi proses dibuat agar pengembangan suatu sistem/software dapat
dimanajemen dengan baik. Dokumentasi produk digunakan setelah sistem/software
selesai atau operasional tetapi juga dapat berguna bagi manajemen proses
pengembangan sistem, dalam kasus perbaikan.
1.
Dokumentasi
Proses
Agar
manajemen dapat efektif, dibutuhkan suatu kejelasan pada proses-proses yang
akan dikelola. Karena software merupakan suatu hal yang non fisik dan proses
pembuatan software juga merupakan tugas-tugas pemikiran yang tidak terlihatfisik,
salah satu cara agar membuat jadi jelas adalah dengan menggunakan dokumentasi.
Kategori Dokumentasi Aplikasi :
- Perencanaan, Perkiraan, dan Penjadwalan
Merupakan dokumen yang dibuat oleh manajer yang digunakan untuk memprediksi dan mengontrol proses software. - Laporan/Reports
Merupakan dokumen yang mencatat bagaimana sumber daya yang digunakan selama proses pengembangan. - Standar
Dokumen ini menentukan bagaimana seharusnya suatu proses di implementasikan. - Lembar Kerja/Working Paper
Merupakan dokumen komunikasi teknis utama dalam suatu proyek. - Memo dan Surat/Pesan Elektronik
Dokumen yang merekam rincian komunikasi sehari-hari antara manajer dan development engineer.
Karakteristik
utama dari dokumentasi proses adalah hampir semuanya akan menjadi kadaluarsa.
Banyak informasi yang akan menjadi tidak berguna apabila telah terlewati dan normalnya
tidak ada kepentingan untuk tetap menyimpannya setelah sistem/software telah
jadi, seperti jadwal / perencanaan pembuatan. Bagaimanapun juga tetap ada
beberapa dokumentasi proses yang berguna apabila ada perubahan software yang
diinginkan, seperti hasil testing dan lembar kerja yang mencatat alasan-alasan
kenapa suatu desain dipilih dalam pembuatan suatu sistem.
2.
Dokumentasi
Produk
Dokumentasi
produk berkenaan dengan gambaran suatu produk software/ sistem yang telah jadi.
Tidak seperti dokumentasi proses, dokumentasi produk biasanya berguna untuk
waktu yang lebih lama, selama produk tersebut masih digunakan. Dokumentasi
produk melingkupi user documentation yang memberitahu pengguna bagaimana cara
mengoperasikan produk software, dan system documentationyang utamanya
diperuntukkan bagi teknisi maintenance
.
·
User
Documentation
Pengguna
dari suatu software / sistem tidaklah dapat disamaratakan. Merupakan suatu hal yang
penting untuk membedakan antara end-userdengan system administrator.
1.End-user
menggunakan software sebagai alat bantu untuk mengerjakan
suatu tugas, menulis sebuah buku, mengelola keuangan, bahkan menerbangkan
pesawat. Mereka ingin tahu seberapa software dapat memudahkan pekerjaan mereka
tetapi tidak ingin tahu detail teknis tentang software tersebut.
2.System
administrator
bertanggung jawab mengelola dan memelihara software
yang digunakan oleh end-user. Dapat berupa operator, network manager, hingga master
teknis yang memecahkan segala permasalahan end-userberkaitan dengan software, atau
juga penghubung antara user dengan software developer.
·
System
Documentation
System
Documentation mencakup semua gambaran sistem itu sendiri mulai dari spesifikasi
kebutuhan hingga hasil pengetesan yang dapat diterima (final acceptance test
plan). Dokumen – dokumen yang menggambarkan bagaimana desain, implementasi dan
pengetesan suatu sistem merupakan dokumen penting untuk bisa memahami dan memaintain
software tersebut. Untuk suatu sistem besar yang dikembangkan dalam rangka
memenuhi spesifikasi kebutuhan dari pelanggan, sistem documentation harus
mencakup :
a. Dokumen yang mencatat kebutuhan pelanggan dan alasan-alasannya.
b. Dokumen yang menggambarkan arsitektur dari sistem.
c. Untuk setiap program yang ada pada sistem, gambaranarsitektur
dari program tersebut.
d. Untuk setiap komponen sistem, gambaran dari fungsionalitas
/ kegunaan dan interface-interfacenya.
e. Listing kode program. Harus disertai komentar-komentar
yang dapat menjelaskan bagian-bagian program yang kompleks beserta alasan penggunaan
metode pengkodean tersebut. Apabila penamaan yang baik dan struktur pemrograman
yang baik telah digunakan, listing kode tersebut akan lebih mudah dipahami
tanpa memerlukan komentar tambahan.
f. Dokumen validasi. Menjelaskan bagaimana setiap program
divalidasi dan kaitannya dengan spesifikasi kebutuhan yang diinginkan oleh pelanggan.
g. Panduan sistem maintenance, yang menjelaskan permasalahan-permasalahan
yang telah diketahui dapat terjadi pada sistem.
Sumber : http://bintarmadayraditya.files.wordpress.com/2012/02/dokumentasi-software.pdf