User Documentation

Pengertian

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.

8 Tips For Writing Better User Documentation to Help End-Users

Jenis User Documentation

Paper manual, meliputi :

  • Install manual
  • Brief getting-started notes
  • Introductory tutorial
  • Thorough tutorial
  • Detailed reference manual
  • Quick reference card
  • Conversation manual

Online manual, meliputi :

  • Online manual
  • Online help
  • Context-sensitive help
  • Online tutorial
  • Animated demonstration
  • Guides
  • FAQs
  • Online communities, newsgroups, listservers, e-mail, chat, and instant messaging

A. Paper User Manual

1.User Manuals

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

Ada beberapa macam tipe manual untuk berbagai tipe user:

  1. Tutorials
  2. Reference Manuals
  3. Quick Reference
  4. User Guide

1. 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.

2.Reference Manual

Reference manual ditujukan untuk expert user. Reference manual disusun supaya user dapat mengambil informasi syntatic yang spesifik dengan cepat(quick retrieval of specific syntatic information). Reference manual menyediakan informasi menyeluruh dari semua fungsi sistem.

3.Quick Reference

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

4. User Guide

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.

B. 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, dan 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, dan kesulitan melihat online manual.

2. Online Help

Pengertian 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 menghungi 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.

Berikut merupakan panduan dalam online help yang diajukan oleh kearsley :

  • Buat agar help system mudah diakses dan mudah untuk keluar.
  • Buat help spesifik mungkin.
  • Kumpulkan data untuk menentukan help apa yang paling diperlukan.
  • Berikan user kontrol atas help system.
  • Buat pesan help seakurat dan selengkap mungkin.
  • Jangan gunakan help dengan tujuan untuk mengkompensasi interface yang buruk.

3.Context-sensitive help

Yaitu Sebuah Icon yang bersimbolkan tanda tanya pada sebuah program yang fungsinya menjelaskan icon yang sedang ditunjuk secara lebih rinci. Berbentuk menu based system yang menyediakan bantuan pada menu option. Contoh: editor help command dan machintos ballon help.

4.  Online Tutorial & Animated Demonstratation

Pengertian 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. Guides

Guides adalah sebuah tata cara penggunaan,buku panduan(paper),sebagai pegangan dalam penggunaan sebuah software yang dibuat oleh progammer. Guides Juga bisa berupa buku / tersedia langsung di dalam aplikasi tersebut atau kita di rujuk(di link) dalam sebuah web costumer support oleh progammer.

6. 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.

7. FAQ’s(Frequently Ask Question

Yaitu pertanyaan2 yang sering di lontarkan/di tanyakan user terhadap penggunaan sebuah program,sehingga pihak developer membuat FAQ’s di luar program mereka dengan tujuannya mengurangi pertanyaan secara langsung(chat online) dengan costumer support.

Online vs Paper Documentation

1. Online Documentation

Kelebihan :
-Fisik tidak banyak memakan tempat,
-Mudah dinavigasikan,
-Dapat memberikan pengalaman yang interaktif pada user
-Secara ekonomi lebih hemat
Kekurangan :
-Kecenderungan user yang lebih suka membaca paper manual,
-Isi yang lebih sedikit,
-User interface yang mungkin menghambat, kesulitan navigasi
-Kesulitan melihat online manual.

2. Paper Documentation

Kelebihan :
-Secara fisik isi lengkap dan terperinci
-Mudah dalam pembacaannya
-Tidak menggunakan jaringan internet
Kekurangan :
-Secara fisik memakan cukup ruang
-Harganya cukup mahal
-User experience nya kurang menarik karena biasanya tidak ada animasi di dalamnya

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
  5. Flexybility, membuat setiap user berinteraksi sesuai keinginannya
  6. Unobtrusiveness, seharusnya tidak mencegah user dalam melanjutkan pekerjaannya atau terpengaruh dengan aplikasi user.

Prinsip dan pedoman User manuals

Prinsip desain ini ditujukan untuk menuju ke 3 tujuan desain utama yaitu :

  1. Ease of Navigation (mudah dinavigasi)
  2. Ease of Learning (mudah dipelajari)
  3. Ease of Reading (mudah dibaca)

1.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)
Index Daftar isi
Poor information desain Good information Desain

2.Ease of Learning

Mempelajari ide yang baru bisa difasilitasi jika informasi disajikan dengan cara yang sesuai dengan natural learning dan problem-solving strategi dari manusia. hal ini bisa dicapai dengan cara :

  • Menyediakan landasannya dan terus berkembang
  • Ajarkan dalam beberapa bagian2 kecil
  • Ajarkan  dalam logical sequence
  • Beri contoh
  • Sediakan ilustrasi
  • Sediakan bagian troubleshooting dan sediakan list dari error message dengan penjelasan detail dan saran
  • Ajarkan dalam logical sequence
  • Hindari abstract, formal notation

3.Ease of Reading

Manual seharusnya ditulis dengan jelas dan sederhana. Manual juga seharusnya dapat dengan cepat dibaca dan dipahami setiap penjelasan dari fitur dan fungsi sistem tsb. hal ini dapat dicapai dengan :

  • Berikan Tanda baca yang baik serta dengan bahasa baku
  • Gunakan white space
  • Hindari jargon yang tidak perlu
  • Tidak menggunakan kalimat yang tidak penting
  • Gunakan Tulisan yang mudah dibaca.

Manfaat dari User Documentation

  1. Mengetahui dengan jelas alur pekerjaan dari sistem
  2. Bukti bahwa kita pernah melakukan developing dan perbaikan sistem
  3. Untuk mengatasi error yang mungkin kita hadapi di masa mendatang dengan cepat
  4. Dapat meminimalkan kesalahan user dan menyediakan kemudahan recovery dari kesalahan

Fungsi dari User Documentation

  1. Memberikan kinerja sistem untuk pengguna
  2. Memberikan panduan interaksi antara pengguna dan sistem
  3. Memberikan panduan kepada pengguna untuk mempelajari sistem
  4. Memberikan panduan kepada pengguna untuk memecahkan masalah

Leave a Comment

Your email address will not be published. Required fields are marked *

Skip to toolbar