Teknik Dokumentasi Aplikasi Pert 4

Produk Dokumentasi

Dokumentasi produk biasanya berguna untuk waktu yang lebih lama selama produk tersebut masih digunakan daripada Dokumentasi Proses yang waktu kadaluwarsa-nya lebih cepat.

Dokumentasi produk ini melingkupi user documentation yang memberitahu pengguna bagaimana cara mengoperasikan produk software, dan system documentation yang diperuntukkan bagi teknisi maintenence.

User documentation,meliputi :

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.



Sumber :
http://bintarmadayraditya.files.wordpress.com/2012/02/dokumentasi-software.pdf
Materi Kuliah TDA

Teknik Dokumentasi Aplikasi Pert 3

Proses Dokumentasi

Untuk membuat software diperlukan proses dokumentasi dimana proses dokumentasi itu dapat membantu pengembang,user dalam hal mengembangkan lagi, maupun maintenence. Dalam proses dokumentasi terdapat beberapa kategori, yaitu :

1. Perencanaan, perkiraan, dan penjadwalan.
2. Laporan – laporan
3. Standarisasi
4. Kertas kerja
5. Pesan email, atau Komunikasi yang berbentuk pesan.

• Dalam kategori yang pertama dokumen dibuat oleh manajer yang berfungsi sebagai prediksi, kontrol, maupun rencana-rencana dasar seperti berapa banyak estimasi biaya, dan bagaimana penjadwalannya. Dokumen ini biasanya dibuat sebelum proyek berjalan, biasa disebut project management plan.

• Dalam Kategori laporan, dokumen ini mencatat bagaimana sumber daya yang digunakan selama mengembangkan software tersebut.

• Standarisasi mengatur bagaimana seharusnya suatu proses diimplementasikan. Semakin bagus suatu perusahaan maka semakin tinggi standard yang digunakan.

• Lembar kerja/ working paper Sering kali merupakan dokumen komunikasi teknis utama dalam suatu proyek. Dokumen ini 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.

• Memo dan surat/pesan elektronik. 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 terlewati dan normalnya tidak ada kepentingan untuk tetap menyimpannya setelah sistem/software telah jadi, seperti jadwal / perencanaan pembuatan.

Sumber : http://bintarmadayraditya.files.wordpress.com/2012/02/dokumentasi-software.pdf