::: Resume Teknik Dokumentasi Aplikasi :::
Part III
PROCESS DOCUMENTATION
Proses Dokumentasi
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 terlihat fisik, salah
satu cara agar membuat jadi jelas adalah dengan menggunakan dokumentasi.
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 :
§
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
§
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.
Proses dokumentasi dibagi menjadi 5 kategori :
Ø Perencanaa, estimasi dan penjadwalan
Dokumen yang diproduksi oleh para manager yang
digunakan untuk memprediksi dan mengontrol proses software
Ø Laporan- laporan
Laporan tentang bagaimana sumber daya-sumber daya apa
yang digunakan selama proses
pengembangan
Ø Standarisasi
Sesuai dengan standart missal :
IEEE 12207
Ø Kertas kerja
Merekam ide dan pemikiran sebuah proyek sebagai versi
sementara yang menjelaskan bentuk software bagaimana, dimana secara tidak
langsung mencatat logika desain software yang diambil. Seperti flowchart, ERD,
dan sebagainya.
Ø Email, wikis, etc
Sebagai sarana komunikasi
antara manager dan pembuat software.
::: Resume Teknik Dokumentasi Aplikasi :::
Part IV
PROduct DOCUMENTATION
Product Dokumentasi
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 : Memudahkan user dengan
tujuan dokumentasi (harus memenuhi keinginan user)
2 kategoro :
1. User
dokumentasi :user mengetahui tentang menggunakan produk software.
2. Dokumen
system : prinsip untuk bagian administration system.
§
System
administrator : gimana menjaga user
§
Manager
dan system evaluator : fungsi system : pejelasan tentang system dan deskripsi
sangat penting di system.
§
Sebuah
instalisasi dokumen digunakan untuk administrator system.
§
System
reference : harus detail/lengkap
§
System
dokumentasi : dokumen harus ada implementasinya,designya
Setiap program harus ada strukturnya
·
User
dokumentasi
1. Deskripsi
fungsi system
2. Dokumen
instalasi
3. Manual
introduksi
4. Manual
referensi
Sistem
Dokumentasi
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
interfaceinterfacenya.
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.
http://www.jivesoftware.com/support/documentation/
