- Dokumentasi Proses Cont. . . . . -
Proses ini menghasilkan software artifact.
Software artifact ini digunakan selama pembangunan software dan perawatan 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. Setiap dokumen yang akan dibuat pasti terdapat definisi, scope dan reference
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. Sumebr yang digunakan adalah sumber IEEE.
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. Dokumen yang merekam rincian komunikasi sehari hari
antara manajer dan development engineer.
- Dokumentasi Produk -
- Product documentation ini menjelaskan tentang hasil dari produk.
Menjelaskan tipe-tipe dokumen dan cara pemilihan tipe dokumentasi tang tepat sesuai dengan kebutuhan dokumentasi.
Terdapat dua kategori dokumentasi produk :
1. User Documentation : menjelaskan kepada use bagaimana cara menggunakan software produk tersebut.
2. System Documentation : diutamakan untuk maintenance engineers.
Pengguna dari sistem itu tidak dapat disamaratakan maka harus dapat membuat dokumentasi yang memudahkan user, dari level yang berbeda pengetahuan dan pengalamannya. Harus ada perbedaan cara pendokumentasian produk antara End User dan System Administration.
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 mengetahui detail teknis tentang software
2. System Administration : bertanggung jawab mengelola dan memelihara software yang digunakan oleh end user. Dapat berupa operator, network manager, hingga master teknis yang emecahkan segala permasalahan end user yang berkaitan dengan software, atu juga penghubung anatara 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.
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.
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.
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
5. System administrator guide :
- Installation + system reference manual.
Sumber :
Materi Kuliah TDA Stikom Surabaya
