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)