Rabu, 27 Juli 2016

User Documentation



User Documentation adalah catatan dari developer tentang error apa saja yang dihadapi dalam membuat software beserta penangannya untuk memperbaiki masalah tersebut.


Tipe-tipe dari user documentation :
1.    Functional description of software/system :
- Secara singkat menggambarkan kebutuhan sistem untuk menjalankan program
- Servis-servis yang dimiliki (fitur2) aplikasi
2.    The system installation document :
- Diperuntukan bagi system administrator.
- Menyediakan informasi mendetail bagaimana cara menginstall system di lingkungan
system yang spesifik.
3. The introductory manual :             
- Menyediakan pengenalan tentang system/aplikasi yang menggambarkan
 fungsi/penggunaan umum dari system/aplikasi tersebut.
4. The system reference manual :
- Menjelaskan semua kegunaan dan fungsi yang dimiliki system/aplikasi

Hal yang perlu diperhatikan dalam user documentation  
  1. General to specific
  2. Explanation to specific
  3. Explicit instruction
  4. Specific to specific inferences (adanya turunan) 
Sifat dari User Documentation:  
  1. - Availabillity : User mampu menggunakan bantuan pada setiap waktu selama user berinteraksi dengan sistem. 
  2. - Accuracy and completeness : Bantuan ini tersedia secara lengkap dan akurat pada user documentation
  3. - Consistency : Harus konsisten pada sistem yang ada antara jenis online dan jenis cetak, serta konsisten dari sisi content dari bentuk-bentuk presentasi
  4. -Robustness

Manfaat dari User Documentation :
  1. Mengetahui dengan jelas alur pekerjaan dari sistem
  2. untuk mengatasi eror yang mungkin kita hadapi dimasa mendatang dengan cepat
  3. Bukti bahwa kita pernah melakukan developing dan perbaikan sistem

Tidak ada komentar:

Posting Komentar