Pendahuluan
Sebuah kasus bisnis biasanya didokumentasikan, yang
dimaksudkan untuk meyakinkan pengambil keputusan untuk menyetujui beberapa
jenis tindakan. Kekuatan kasus bisnis adalah
setiap bit sama pentingnya dengan nilai yang melekat dalam proyek tersebut. Jika tidak dapat menunjukkan
nilai proyek untuk perusahaan, nilai yang mungkin tidak dimengerti. Dan jika nilai proyek untuk
perusahaan tidak dipahami, proposal tidak mungkin disetujui.
Sebuah dokumen kasus bisnis harus mengikuti format standar yang cukup relevan untuk semua jenis proyek. Namun, ada pertimbangan khusus untuk berbagai jenis kasus bisnis.
Sebuah dokumen kasus bisnis harus mengikuti format standar yang cukup relevan untuk semua jenis proyek. Namun, ada pertimbangan khusus untuk berbagai jenis kasus bisnis.
Dokumentasi
Proses dan Dokumentasi Produk
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 :
1.
Dokumentasi proses dokumen-dokumen
ini merekam proses pengembangan dan maintenance. Rencana-rencana,
jadwal-jadwal, dokumen kualitas proses, standarorganisasi dan standar proses
merupakan dokumentasi proses
2.
Dokumentasi produk dokumentasi ini menggambarkan produk yang sedang dikembangkan.
Dokumentasi sistem menjelaskan produkdari 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 atau revisi suatu sistem/software.
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-userdengan system
administrator.
1. End-user
menggunakan software
sebagai alat bantu untuk men gerjakan 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
bertanggung jawab
mengelola dan memelihara software yang digunakan oleh end-user. Dapat berupa
operator, network manager, hingga master teknis yang memecahkan segala
permasalahan end-user berkaitan dengan software, atau juga penghubung antara
user dengan software developer.
System Documentation
Untuk suatu
sistem besar yang
dikembangkan dalam rangka memenuhi
spesifikasi kebutuhan
dari pelanggan, sistem documentation harus mencakup
:
1.
Dokumen yang mencatat kebutuhan pelanggan
dan alasan-alasannya.
2. Dokumen yang menggambarkan
arsitektur dari sistem
3. Untuk setiap
program
yang ada pada sistem, gambaran arsitektur dari
program
tersebut.
4. Untuk setiap
komponen
sistem, gambaran dari
fungsionalitas
/ kegunaan dan
interface-
interfacenya.
5. 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.
6. Dokumen validasi. Menjelaskan
bagaimana setiap program divalidasi dan kaitannya dengan
spesifikasi kebutuhan
yang
diinginkan
oleh pelanggan.
7. Panduan sistem maintenance, yang menjelaskan permasalahan-permasalahan yang
telah
diketahui
dapat terjadi pada sistem.
Kualitas Dokumen
Banyak sekali
dokumentasi sistem
komputer ditulis dengan kualitas
yang rendah, yaitu
sulit dimengerti, out of date dan tidak lengkap.
Kualitas dokumen merupakan hal yang sama pentingnya
dengan kualitas
software. Tanpa adanya informasi bagaimana suatu software dapat digunakan
atau dipahami, kegunaan suatu software akan menurun.
Untuk mendapatkan
dokumentasi
yang
berkualitas dibutuhkan komitmen pada desain
dokumen, standar dan
proses penjaminan
kualitas. Membuat dokumen yang baik tidak mudah dan murah, serta banyak software engineer yang kesulitan untuk membuat dokumentasi yang berkualitas.
Struktur Dokumen
Struktur dokumen yang baik dan benar juga dapat memudahkan pembaca untuk mencari informasi yang benar-benar diperlukan. Berdasarkan standar IEEE untuk user documentation, struktur dokumentasi sebaiknya memiliki komponen-komponen antara lain :
a. Identifikasi
data : data seperti
judul dan identifier dapat mengidentifikasikan
dokumen
secara unik.
b. Daftar isi : berisi
nama bab/sub
bab dan nomor halaman
c. Daftar Ilustrasi : berisi nomor ilustrasi dan
nomor halamannya
d. Introduction/pengantar : menjelaskan
tujuan
dari dokumen dan ringkasan singkat tentang isi dari
dokumen
e. Informasi penggunaan dokumen : saran
bagi
berbagai macam pembaca tentang
bagaimana menggunakan dokumen secara efektif
f. Konsep operasi :
penjelasan latarbelakang konseptual untuk menggunakan software
g. Prosedur : petunjuk penggunaan
software
h. Informasi perintah
dalam software : penjelasan tiap perintah
yang
ada
pada software
i. Pesan kesalahan dan
pemecahannya : penjelasan
bagaimana suatu
error/kesalahan
yang
dapat terjadi pada program ditampilkan dan
bagaimana cara
mengatasinya
j. Glossary : definisi
dari penggunaan istilah khusus
k. Sumber informasi
terkait : referensi ke dokumen
lain yang dapat menyediakan
informasi
tambahan
l. Fitur navigasi : fitur yang
dapat digunakan
pembaca lokasi yang
sedang
dibaca
dan bagaimana berpindah ke bagian lain dari dokumen
m. Index : daftar kata-kata kunci
dan halaman dimana kata tersebut dipakai
n. Kemampuan
pencarian :
pada dokumen elektronik /digital ,
suatu cara mencari
kata
yang digunakan
dalam dokumen
Sumber ::
