.::. Dokumentasi Proses dan Dokumentasi Produk .::.
Dalam proses pengembangan, ada banyak jenis dokumen yang dapat
dihasilkan. Beberapa dokumen yang diproduksi dalam proyek dapat dikategorikan
dalam 2 kelas yang berbeda :
1. Dokumentasi
proses :: dokumentasi yang merekam proses pengembangan dan maintenance.
Rencana-rencana, jadwal-jadwal, dokumen kualitas proses, standar organisasi dan
standar proses merupakan dokumentasi proses.
2. Dokumentasi produk :: dokumentasi yang menggambarkan
produk yang sedang dikembangkan. Menjelaskan produk dari sudut pandang teknis dalam
mengembangkan dan memelihara sistem.
- 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 atau revisi suatu sistem/software.
.::. Dokumentasi Proses .::.
- Proses ini
akan menghasilkan banyak artefak perangkat lunak
- Software artifact
adalah sepotong informasi yang digunakan atau dihasilkan dalam suatu proses
rekayasa software. Artifact dapat berupa model, deskripsi atau software.
-
Ada beberapa kategori dokumentasi proses :
1. Perencanaan,
perkiraan dan penjadwalan
Merupakan dokumen yang dibuat oleh manajer, yang
digunakan untuk memprediksi dan mengontrol proses software.
2. Laporan / Reports
Merupakan dokumen yang mencatat bagaimana sumber daya
digunakan selama proses pengembangan.
3. Standar
Dokumen – dokumen ini menentukan bagaimana
seharusnya suatu proses diimplementasikan. Ada berbagai macam standar mulai
dalam lingkup organisasi, nasional bahkan internasional. Contohnya : ISO, IEEE
, dll.
4. Lembar kerja/ working paper.
- Merupakan
dokumen komunikasi teknis utama dalam suatu proyek.
- Merekam ide
dan pikiran para engineer secara sementara.
- Untuk mencatat
alasan-alasan pemilihan suatu keputusan dalam desain.
5. E-mail messages, wikis, dll.
- 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 kadarluasa dan tidak ada untuk tetap
menyimpannya setelah sistem/software telah jadi, seperti jadwal / perencanaan
pembuatan.
.::. 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
documentation yang utamanya diperuntukkan bagi teknisi maintenance.
.::. User Documentation .::.
Pengguna dari suatu software / sistem tidaklah dapat disamaratakan.
Merupakan suatu hal yang penting untuk membedakan antara end-user dengan system
administrator.
1. End-user
- Pengguna akhir ingin tahu bagaimana perangkat
lunak dapat membantu dan memudahkan mereka dalam mengerjakan suatu tugas.
- Pengguna akhir 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,
dll.
.::. Tipe-tipe User Documentation .::.
Untuk memenuhi kebutuhan berbagai macam user beserta keahliannya yang
masing-masing berbeda, paling tidak ada 5 macam dokumen yang harus diikutsertakan
dalam penyerahan suatu produk software/sistem :
1. Functional system
description
a.
Secara singkat
menggambarkan kebutuhan sistem untuk menjalankan program
b.
Servis-servis
yang dimiliki (fitur2) aplikasi
c.
Gambaran
umum dr aplikasi (abstraksi)
à User dapat menentukan apakah aplikasi benar-benar dibutuhkan hanya
dengan membaca functional description dan introductory manual.
2. Installation document
a.
Diperuntukan
bagi system administrator.
b.
Menyediakan
informasi mendetail bagaimana cara menginstall system di lingkungan system yang
spesifik.
c.
Mencantumkan
gambaran file-file apa yang membentuk suatu sistem/aplikasi
d.
Persyaratan
minimum dari hardware yang dibutuhkan.
e.
File-file(aplikasi)
yang harus ada sebelum sistem diinstall
f.
Cara memulai
system/aplikasi
g.
Cara
mengkonfigurasi aplikasi agar berjalan dengan system yang telah ada
à Adanya installer otomatis untuk aplikasi-aplikasi sekarang membuat
para pembuat S/W memandang tidak perlu adanya dokumen ini, padahal pada
kenyataannya dokumen instalasi ini masih dibutuhkan agar para System manager
dapat menemukan dan memecahkan sumber masalah jika ada problem pada waktu
instalasi.
3. Introductory manual
a. Menyediakan
pengenalan tentang system/aplikasi yang menggambarkan fungsi/penggunaan umum
dari system/aplikasi tersebut.
b.
Menjelaskan
cara memulai menggunakan program
c. Menjelaskan
bagaimana para user dapat menggunakan fungsi-fungsi umum yang dimiliki aplikasi
disertai ilustrasi dan contoh bebas.
d. Mencantumkan
kesalahan-kesalahan yang umum/sering dilakukan oleh user dan cara
menyelesaikannya.
4. Reference manual
a.
Menjelaskan
semua kegunaan dan fungsi yang dimiliki system/aplikasi
b.
Mencantumkan
semua pesan kesalahan yang dimiliki sistem dan cara mengatasinya secara lengkap
dan detail
c.
Penggunaan
bahasa resmi dan teknik bisa digunakan
à Mencantumkan secara lengkap fitur dan cara operasional dari
system/aplikasi
Referensi :
http://aqwam.staff.jak-stik.ac.id/files/34.-uml.pdf
https://sites.google.com/site/kuliahtda/my-forms
https://sites.google.com/site/kuliahtda/my-forms
