Nama :: Dyah Ayu Anggraeni
NIM :: 10410110017
Prodi :: S1 KA
:: ^^PART 3^^ ::
..:: DOKUMENTASI PROSES ::..
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.
: : KATEGORI PROSES DOKUMENTASI
: :
Proses Dokumentasi dibagi menjadi 5
kategori yaitu :
1. Perencanaan, perkiraan dan penjadwalan :
Merupakan
dokumen yang dibuat oleh manager yang digunakan untuk memperkirakan dan
mengatur proses software.
2. Laporan/Report :
Merupakan dokumen yang
menginformasikan bagaimana sumber daya digunakan saat proses pengembangan.
3. Standart :
Dokumen yang menjelaskan bagaimana
proses itu berjalan. Dokumen – dokumen ini menentukan
bagaimana seharusnya suatu proses diimplementasikan. Ada berbagai macam standar
mulai dalam lingkup organisasi, nasional bahkan internasional.
4. Lembar kerja/ working paper :
Sering kali merupakan dokumen
komunikasi teknis utama dalam suatu proyek. Mereka merekam ide-ide dan
pikiran-pikiran para engineer yang bekerja dalam proyek, yang merupakan
dokumentasi produk versi sementara yang menjelaskan strategi pengimplementasian
dan penentuan masalah yang telah diidentifikasi. Seringkali dokumen ini mencatat
alasan-alasan pemilihan suatu keputusan dalam desain.
5. Memo dan surat/pesan elektronik :
Berisi
detail percakapan antara manager dan pekerja.
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.
Sistem
dokumentasi merupakan keseluruhan dokumen yang berhubungan dengan kebutuhan
sistem hingga uji coba sistem tahap terakhir. Dokumen ini menjabarkan
rancangan, implementasi dan uji coba dari sistem yang berguna dalam proses
perawatannya.
Sistem
dokumentasi mencakup :
1. Dokumen yang
menjelaskan spesifikasi dari sistem.
2. Dokumen yang
berisi tentang bagan-bagan sistem.
3. Deskripsi
dari masing-masing bagan tersebut.
4. Menjelaskan
fungsi dari setiap komponen.
5. Daftar pusat
code dari program.
6. Dokumen hak
cipta program dan validasi dokumen menggambarkan bagaimana masing-masing
program tersebut divalidasi dan bagaimana validasi informasi.
:: ^^PART4^^ ::
..:: DOKUMENTASI PRODUK ::..
Dokumentasi
produk merupakan 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 di gunakan.
Kualitas teknik
Dokumentasi :
Kualitas
dalam teknik publikasi adalah relatif
- Kualitas dalam teknik publikasi
tergantung pada persepsi seorang pengguna (pembaca)
- Kesesuaian dengan persyaratan
(Crosby, 1979)
Syarat dari teknik
publikasi dari sebuah buku :
- Memberikan nilai/informasi yang baik.
- Informasi yang digunakan akurat
- Customer tidak banyak tanya
- Pengeluaran yang dikeluarkan dengan rendah :
- Memberikan batasan yang rendah terhadap orang yang tidak suka membaca
- Mengurangi biaya dukungan dari customer support
- Tidak banyak turun lapangan tetapi banyak memmbaca buku petunjuk
- Meningkatkan penjualan
6 langkah dalam proses menulis :
- Analisa pembaca : Mengetahui dan menganalisa siapa yang akan membaca buku kita sangatlah penting, hal ini dikarenakan agar buku yang telah dibuat tidak salah sasaran.
- Membuat ringkasan : Agar para pembaca mengetahui definisi awal atau ringkasan dari buku maka perlu ditambahkan untuk menarik minat para pembaca.
- Mebuat rincian : Setelah ringkasan dapat membuat tertarik para pembaca, tentu saja di dalam buku harus dibuatkan pendefinisian secara rinci mengenai materi yang dibawakan.
- Memilih gaya dan format yang akan digunakan : Gaya penulisan dan format penulisan perlu diperhatikan agar tidak membuat pembaca merasa bosan dengan isi buku dan juga agar pembaca tertarik untuk membaca buku.
- Menulis buku manual : Setelah semua bahan di atas dipersiapkan, maka sekarang waktunya untuk menulis bukunya berdasarkan konsep - konsep di atas.
- Mencoba buku manual : Jika buku sudah dibuat, proses selanjutnya melakukan percobaan kepada para pembaca.
Dokumentasi
produk meliputi ::
· User
Documentation :
menjelaskan kepada user bagaimana cara mengoprasikan produk software.
· 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
antar end-user dengan 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-user berkaitan dengan
software, atau juga penghubung antara user dengan software developer.
:: Tipe-Tipe User Documentation ::
1. Functional description of software/system :
- Secara singkat menggambarkan kebutuhan sistem untuk menjalankan program
- Servis-servis yang dimiliki (fitur2) aplikasi
- Gambaran umum dr aplikasi (abstraksi)
=>User dapat menentukan apakah aplikasi benar-benar dibutuhkan hanya dengan
membaca functional description dan introductory manual.
- Secara singkat menggambarkan kebutuhan sistem untuk menjalankan program
- Servis-servis yang dimiliki (fitur2) aplikasi
- Gambaran umum dr aplikasi (abstraksi)
=>User dapat menentukan apakah aplikasi benar-benar dibutuhkan hanya dengan
membaca functional description dan introductory manual.
2. The system installation document :
- Diperuntukan bagi system administrator.
- Menyediakan informasi mendetail bagaimana cara menginstall system di lingkungan
system yang spesifik.
- Mencantumkan gambaran file-file apa yang membentuk suatu sistem/aplikasi
- Persyaratan minimum dari hardware yang dibutuhkan.
- File-file(aplikasi) yang harus ada sebelum sistem diinstall
- Cara memulai system/aplikasi
- 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.
- Diperuntukan bagi system administrator.
- Menyediakan informasi mendetail bagaimana cara menginstall system di lingkungan
system yang spesifik.
- Mencantumkan gambaran file-file apa yang membentuk suatu sistem/aplikasi
- Persyaratan minimum dari hardware yang dibutuhkan.
- File-file(aplikasi) yang harus ada sebelum sistem diinstall
- Cara memulai system/aplikasi
- 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. The introductory manual :
- Menyediakan pengenalan tentang system/aplikasi yang menggambarkan
fungsi/penggunaan umum dari system/aplikasi tersebut.
- Menjelaskan cara memulai menggunakan program
- Menjelaskan bagaimana para user dapat menggunakan fungsi-fungsi umum yang
dimiliki aplikasi disertai ilustrasi dan contoh bebas.
- Mencantumkan kesalahan-kesalahan yang umum/sering dilakukan oleh user dan
cara menyelesaikannya.
- Menyediakan pengenalan tentang system/aplikasi yang menggambarkan
fungsi/penggunaan umum dari system/aplikasi tersebut.
- Menjelaskan cara memulai menggunakan program
- Menjelaskan bagaimana para user dapat menggunakan fungsi-fungsi umum yang
dimiliki aplikasi disertai ilustrasi dan contoh bebas.
- Mencantumkan kesalahan-kesalahan yang umum/sering dilakukan oleh user dan
cara menyelesaikannya.
4. The system
reference manual :
- Menjelaskan semua kegunaan dan fungsi yang dimiliki system/aplikasi
- Mencantumkan semua pesan kesalahan yang dimiliki sistem dan cara mengatasinya
secara lengkap dan detail
- Penggunaan bahasa resmi dan teknik bisa digunakan
=>Mencantumkan secara lengkap fitur dan cara operasional dari system/aplikasi
- Menjelaskan semua kegunaan dan fungsi yang dimiliki system/aplikasi
- Mencantumkan semua pesan kesalahan yang dimiliki sistem dan cara mengatasinya
secara lengkap dan detail
- Penggunaan bahasa resmi dan teknik bisa digunakan
=>Mencantumkan secara lengkap fitur dan cara operasional dari system/aplikasi
5. System
administrator guide :
- Installation + system reference manual.
- Installation + system reference manual.
:: 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 :
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.
SUMBER::