User Documentation

Pengertian User Documentation

User Documentation adalah Dokumentasi dari suatu produk atau service yang disediakan untuk end users. User Documentation di desain untuk membantu end users dalam menggunakan suatu produk/service.

Jenis-Jenis User Documentation

• Online User Manual

1. Online Manual

Online manual memiliki keunggulan dalam empat hal yaitu:

- Secara fisik tidak banyak memakan tempat

- Mudah dinavigasikan

- Dapat memberikan pengalaman yang interaktif pada user

- Secara ekonomi lebih hemat

Namun online manual juga memiliki beberapa kelemahan yaitu:

- Kecenderungan user yang lebih suka membaca paper manual

- Isi yang lebih sedikit

- User interface yang mungkin menghambat

- Kesulitan navigasi

- Kesulitan melihat online manual.

2.  Online Help 

Online Help ialah cara yang disediakan oleh develop/progammer jika dalam manual online maupun manual paper tidak bisa menjawab pertanyaan user maka bisa menggunakan online help atau yang bisa kita sebut menghubungi costumer service atau admin.Hal ini tentunya kita akan bertanya langsung(instant) tentang apa saja pertanyaan kita yang belum di jawab di user manual/paper manual.

3.  Context-Sensitive Help

Yaitu Sebuah Icon yang bersimbolkan tanda tanya pada sebuah program yang fungsinya menjelaskan icon yang sedang ditunjuk secara lebih rinci.

 

 4.  Online Tutorial & Animated Demonstratation

Online tutorial ialah sekumpulan atau beberapa video atau langkah2 yang disediakan oleh develop/progammer dalam suatu aplikasi untuk memudahkan user memahami suatu program atau aplikasi.

 
 5. Online Communities, Newsgroups, E-mail, Chat, and Instant Messaging

Maksudnya ialah layanan yang tersedia di luar aplikasi tersebut apabila dalam user manual(offline)tidak bisa menjawab pertanyaan daripada user,jadi kita bisa bertanya pada user layanin di sebuah web tersebut dan bercerita seputar aplikasi yang mereka pakai.

 

Online help principle & guidelines

•Membuat help selalu/mudah terlihat(visible)

•Buat secara lengkap dan akurat

•Sediakan beberapa cara untuk mengaksesnya

•Buat help yang berkaitan dengan user’s task dan user’s goal

•Sediakan beberapa level penjelasan untuk berbagai macam user

•Buat help yang mudah dipelajari dan dinavigasikan

•Sediakan desain layout yang menarik

•Gunakan windowing/kotak dialog

 

• Paper User Manual

  1.  User Manual
  

  
  

  User Manuals adalah sebuah bagian dari user interface untuk sebuah sistem komputer. User manual juga sering menjadi satu2nya support yang dimiliki user untuk troubleshooting yang dirangkum dalam sebuah buku.

  
  

  Ada beberapa macam tipe manual untuk berbagai tipe user:

  
  

  1.Tutorials

  
  

  2.Reference Manuals

  
  

  3.Quick Reference

  
  

  4.User Guide

2. Tutorials

Tutorials cocok untuk true novices user. User tipe ini hanya tahu sedikit tentang Semantics of the application(What the system can do) dan juga Syntax of the human interface(precisely how to do anything in particular on the system).

Tutorial dibuat untuk dibaca dari cover ke cover dan juga di organisasi sebagai course/training untuk program tsb.

  

3.  Detailed Reference Manual

Biasanya pada bagian ini menjelaskan secara terperinci kesalahan2 yang umum terjadi pada user dalam menggunakan suatu aplikasi yang dibuat oleh develop/progammer.Serta beberapa pertanyaan umum yang sering dikeluhkan user(FAQ)yang jumlahnya terbatas.

Reference manual menyediakan informasi menyeluruh dari semua fungsi sistem.

 

4.  Quick Reference

Quick Reference adalah ringkasan informasi dari bagian kecil dari fungsi yang sering digunakan atau penting. ditujukan untuk experts user.

 

5.  User Guides

User Guide ditujukan untuk intermediate user. User Guide harus memenuhi kebutuhan dari semua tipe user. maka dari itu User Guide harus memperbolehkan user untuk dengan mudah melewati informasi yang user sudah tahu tapi juga tidak mengharuskan user familiar dengan detail dari syntax dari sebuah sistem.

 

 

ONLINE VS PAPER DOCUMENTATION 

1. Online Documentation

2. Paper Documentation

 

SIFAT-SIFAT USER DOCUMENTATION

1.Availability

User dapat menggunakan bantuan setiap saat selama sedang berinteraksi dengan sistem. User tidak perlu keluar dari aplikasi ketika ingin membuka aplikasi bantuan.

2. Accuracy and Completeness

  Bantuan seharusnya tersedia secara akurat dan lengkap

3.Consistency

Konsistensi pada sistem yang ada, antara jenis online dan jenis tercetak, serta konsisten dari sisi content, terminologi dan bentuk presentasi.

4.Robustness

Kemampuan untuk melanjutkan operasi ketika sistem mempunyai perilaku yang tidak diharapkan.Biasanya digunakan oleh orang yang sedang dalam kesulitan karena sistem mempunyai perilaku yang tidak di harapkan atau memiliki masalah

4. flexybility

membuat setiap user berinteraksi sesuai keinginannya

5. Unobtrusiveness

seharusnya tidak mencegah user dalam melanjutkan pekerjaannya atau terpengaruh dengan aplikasi user.

 

TAHAPAN-TAHAPAN DALAM MEMBUAT USER DOCUMENTASI YANG BAIK

•Ease of Navigation

Prinsip untuk mendesain good navigation membantu mengarahkan sebagus apa dokumentasi itu di organisasi untuk memfasilitasi dalam mencari bagian/topik tertentu. Ada beberapa prinsip dalam memenuhi ease of navigation yaitu:

- Daftar isi harus menyediakan pandangan garis besar nya saja bukan list yang terlalu panjang

- Sediakan index dengan catatan untuk user goal dan task/operation name

- Pisahkan jenis2 informasi dan gunakan petunjuk yang konsisten pada setiap jenis(motivational,conceptual, procedural dan example)

• Ease of Learning(Mudah Dipelajari)

hal-hal yang perlu diperhatikan :

-Logical sequent (urutan logika)

-Berikanlah ilustrasi

-Berikan sampel

-berikan contoh gambaran abstract untuk menjelaskan sebuah penjelasan dengan bahasa yang mudah dipelajari user

 

• Ease of Reading(Mudah Dibaca)

  hal-hal yang diperhatikan :

•Berikan Tanda baca yang baik serta dengan bahasa baku

•Tidak menggunakan kalimat yang tidak penting

•Berikan jargon (hastag)

•Gunakan Tulisan yang mudah dibaca(baku = times new roman)

Response Time

Pengertian Response  Time

adalah lama waktu yang dibutuhkan setelah user/ pengguna mengawali aktivitas input sampai komputer dapat menampilkan hasil respon.

Respon Time Lambat Vs. Respon Time Cepat :

Faktor - Faktor yang mempengaruhi Respon Time :

• Kompleksitas interaksi : sebuah input yang memiliki rangkaian perintah yang panjang dapat memengaruhi respon time komputer. Contoh : perbandingan waktu respon saat membuka program notepad dengan Photoshop.
• Keahlian user dalam mengoperasikan perangkat : user yang ahli akan lebih paham langkah yang harus diambil sehingga respon menjadi lebih singkat. Contoh : seorang programmer lebih cepat mengoperasikan komputer dibandingkan tukang siomay.
• Kecepatan proses data dibagi menjadi 2 : 

1. Kecepatan data Internet : google.com dan youtube.com, dalam membuka url web browser tersebut terlihat perbedaan banyak data yang diproses, dan memengaruhi kecepatan respon.
2. Kecepatan data Read and Write : saat data mengalir dari/kesebuah tempat penyimpanan, kecepatan akses ditentukan oleh seberapa cepat kemampuan read dan write.

• Jumlah user : jumlah user yang banyak saat mengakses data dapat memengaruhi kecepatan respon sistem.
• Kemampuan dari perangkat itu sendiri : contoh Laptop dengan Spesifikasi tinggi (gaming), dengan laptop lawas dan spesifikasi rendah, waktu respon time akan terlihat jelas.

Faktor yang mempengaruhi Ekspektasi Waktu Respon :

• Pengalaman sebelumnya yang dilakukan oleh user mengenai waktu yang dibutuhkan untuk menyelesaikan tugas tertentu.
• Ragam individu dan tugas yang bervariasi.
• User sangat adaptif.

Beberapa Hal Terkait Response Time-Limit :

•  0,1 detik adalah batas waktu agar pengguna merasa bahwa sistem bereaksi seketika, artinya tidak diperlukan umpan balik khusus kecuali untuk menampilkan hasilnya.
• 1.0 detik adalah batas waktu agar pemikiran pengguna untuk tetaptidak terganggu, meski pengguna akan memperhatikan penundaan tersebut. Biasanya, tidak ada umpan balik khusus yang diperlukan selama penundaan lebih dari 0,1 dan kurang dari 1,0 detik.
• 10 detik adalah batas untuk menjaga perhatian pengguna terfokus pada dialog. Untuk penundaan yang lebih lama, pengguna akan cenderung melakukan tugas lain sambil menunggu proses yang lebih lama, pengguna akan cenderung melakukan tugas lain samil menunggu proses sebelumnya selesai, jadi mereka harus diberi umpan balik yang menunjukkan kapan komputer tersebut mengharapkan untuk dilakukan.

Error Handling

Apa itu Error Handling ?

Error Handling adalah satu penanganan kesalahan (eror) pada berbagai macam keadaan dalam pemrograman. Setiap ada kesalahan, maka eksekusi program tidak akan dihentikan secara tiba tiba, tetapi akan diteruskan ke baris program yang terdapat script penanganan kesalahan.

Gambar dibawah ini merupakan contoh Error yang diakibatkan karena tidak mencentang salah satu dari opsi yang disediakan.

Penanganan Kesalahan

• Meminimalkan kesalahan user.
• Interaksi melalui menu lebih dapat menghindarkan user dari kesalahan daripada menggunakan perintah baris.
• Compaq pernah mempertimbangkan untuk mengubah “Press Any Key” menjadi “Press Enter Key” dikarenakan banyak telpon yang menanyakan letak tombol “Any” di keyboard.
• Cara mengurangi kesalahan user, misal: seleksi user yang tepat, pelatihan yang memadai, desain peralatan, prosedur dan lingkungan.
• Menyediakan kemudahan recovery dari kesalahan.

Kelebihan dan Kekurangan Error Handling

Macam - Macam Jenis Error :

• Perceptual Error: adanya kesalahan yang disebabkan oleh ketidakjelasan keterangan dari petunjuk penggunaan yang menyebabkan kesalah tanggapan dari pihak pengguna atau user. Contoh : Icon yang ambigu dalam desain antarmuka.

• Cognitive Error : Kesalahan yang diakibatkan oleh kemampuan memecah oleh user atau karena banyak konteks dan informasi status. 

• Motor Error : kesalahan yang disebabkan oleh ketidak sinkronan antara mata, tangan, dan kemampuan yang dimiliki oleh user. Contoh : typo / terlalu cepat mengetik, double klik pada mouse.
  

Jenis - Jenis Kesalahan Dari User :

1. Mistake : kesalahan yang terjadi ketika user berpikir bahwa sudah melakukan hal yang benar namun sebenarnya user melakukan kesalahan. 

2. Slip : kesalahan diluar keinginan user. Contoh : saat ingin menutup user ingin mengklik tombol close tetapi secara tidak sengaja user menekan tombol minimize.

Jenis - Jenis Kesalahan Pada Program :

- Syntax Error : kesalahan dari penulisan syntax pada program sehingga syntax tersebut tidak dapat dieksekusi oleh program dan membuat program eror. Contoh : pada C++, baris kode harus selalu diakhiri dengan tanda (;) atau kesalahan penulisan pada standar penulisan program.

- Logical Error : kesalahan yang disebabkan oleh programmer karena kesalahan penulisan atau rumus yang diterapkan. Contoh : saat kita membuat program yang menghasilkan nilai luas, kita menuliskan 7 tetapi hasil yang ditampilkan program adalah 11 atau pada saat kita menulis variabel s adalah hasil tambah, tetapi yang didekrasikan pada awal adalah S besar.

- Runtime Error : kesalahan yang terjadi ketika sebuah program komputer dijalankan. 

    Cara Membuat Error Handling yang Baik : 

1. Gunakan bahasa yang mudah dipahami oleh user.
2. Hindari kata - kata seperti : bad, dummy, dll.
3. Hindari kalimat perintah.
4. FAQ ( Frequently Asked Questions ).
5. Optimalisasikan dan pemanfaatan undo redo function dan cancel.
6. Menyiapkan berbagai macam model respon.
7. Validitas masukan / inteligent error checking dan recovery.
8. Proteksi pengguna.
9. Penampilan pesan.
10. Optimasikan fungsi HELP ( quick access help ).
11. Editing of Error Fields.
12. Desain yang efektif dan effisien.
13. Return cursor dan Highlight error.
14. No Interupting Work Flow.
15. Confirmation Commands.

Tips sederhana untuk mencegah terjadinya error dalam program :

•  Menulislah dengan teliti, coba ikuti aturan penulisan program dengan benar dan konsisten.
• Menulislah dengan rapi, coba ikuti aturan penulisan program yang baik atau mengikuti konvensi ( coding standar ).  Hal ini akan mempermudah dalam pencarian kesalahan program.
• Selalu konsisten dalam penamaan variabel dan sejenisnya juga membantu mencegah terjadinya error karena terkadang kesalahan terjadi karena perbedaan huruf besar dan kecil.
• Pastikan algoritma yang digunakan sudah teruji kebenarannya.