Teknik Dokumentasi Aplikasi -Chapter 4-

Product documentation

-Menjelaskan produk yang disampaikan dan harus berkembang dengan pengembangan produk perangkat lunak.

- Menjelaskan mengenai bentuk bukunya, bentuk bukunya berupa:

1. Buku panduan pengenalan

2. Buku panduan pelatihan

3. Buku panduan pengguna

4. Buku panduan referensi

5. Buku panduan struktur database, dsb.

- Ada hubungannya dengan cara menyampaikan produknya dan mempunyai umur panjang

- Ada kategori: user documentation, user manual

- Sistem dokumentasi: Semua prinsip dari proses dokumentasi. Menjelaskan bagaimana sistem bekerja, tetapi bukan cara mengoperasikannya.

Contoh: Persyaratan Spesifikasi, Desain Arsitektur, Rancangan rinci, Komentar Source Code, Termasuk keluaran seperti javadoc, Test Plan, Termasuk test case, V & V rencana dan hasil, Daftar bugs yang dikenal

- User dokumentasi: harus bisa membuat dokumentasi untuk memudahkan tugas dari user yang berbeda-beda dan dilihat dari pengalaman dan pengetahuan

- End-user: tidak membutuhkan proses pembuatan software tapi membutuhkan software tersebut untuk membantu tugasnya

- Sistem Administrator: bertanggjung jawab mengelola dan mengetahui permintaan dan pemetaan sistem software yang digunakan end-user.

Jenis-jenis dari user:

a. Manager & sistem evaluator

b. System administrator

c. Novice users

d. Experienced users

e. System Administrators

-Ada lima bidang penting yang harus didokumentasikan untuk rilis resmi dari aplikasi perangkat lunak. Ini tidak selalu masing-masing harus memiliki dokumen mereka sendiri, tetapi topik harus ditutup secara menyeluruh.

1. Deskripsi Fungsional perangkat lunak:

-Secara garis besar mengenai kebutuhan dan sedikit tentang servis yang disediakan

-Membutuhkan tentang penjelasan sistem

-User harus bisa membaca dokumen dan menentukan sistem yang akan dibutuhkan dan dibuat

2. Sistem/Instruksi instalasi: dibutuhkan oleh sistem administrator untuk menyediakan informasi mendetail bagaimana cara menginstall sistem di lingkungan sistem yang spesifik dan mencantumkan gambaran file-file apa yang membentuk suatu sistem/aplikasi

3. Introduction manual:

-Lebih ke penggunaan normalnya

-Menjelaskan bagaimana memulai software dan bagaimana pengguna menggunakan sistem fasilitas pada umumnya

4. Sistem referensi:

-Menjelaskan semua kegunaan dan fungsi yang dimiliki sistem/aplikasi

-Tersedia daftar error message-nya dan menjelaskan bagaimana memulihkan error

-Sistem harus komplit

-Teknik formal deskriptif seharusnya digunakan

5. Sistem dokumentasi: mencakup semua gambaran sistem itu sendiri mulai dari spesifikasi kebutuhan hingga hasil pengetesan yang dapat diterima termasuk dokumen requirement plan, yang harus ada:

a. Requirement: Kebutuhan pengguna dan perangkat lunak

b. Dokumentasi yang menjelaskan desain arsitektur

c. Deskripsi arsitektur

d. Deskripsi fungsional dan antarmuka

e. Source code, dengan penamaan yang standar yang dicetak harus sesuai fungsinya. Ex: source code dari transaksi

f. Dokumen validasi menjelaskan bagaimana setiap program berjalan.

Sumber Pustaka:
Catatan Materi Kuliah TDA pert 4
http://www.eecs.ucf.edu/~turgut/COURSES/EEL6883_SEII_Spr07/PaperPresentations/Sommerville-p143.ppt
http://www.literateprogramming.com/documentation.pdf‎
-Thanks to Google Translate-

By: Azid Malil'ula Wildan M (10410110014)-S1 Komputerisasi Akuntansi