User Documentation

Pengertian User Dokumentasi

Dokumentasi dari suatu produk atau service yang disediakan untuk end users.

Jenis User Dokumentasi :

  1. Paper User Manual
  2. Online User Manual

Paper User Manual

User manual adalah sebuah bagian dari user interface untuk sebuah sistem komputer. User manual juga sering menjadi salah satu support yang dimiliki user untuk troubleshotting.
Ada beberapa macam tipe manual untuk berbagai tipe user :

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

Tutorials

Tutorial cocok digunakan untuk novice user. karena user tipe ini hanya memiliki sedikit pengetahuan tentang Semantics of the Application (Apa yang bisa dilakukan sistem) dan juga Syntax of the human interface (tepatnya bagaimana melakukan sesuatu secara khusus pada sistem).

Detailed Reference Manual

Pada bagian ini biasanya menjelaskan secara rinci kesalahan error yang umum terjadi pada user dalam menggunakan suatu aplikasi yang dibuat oleh developer. Serta beberapa pertanyaan umum yang sering dikeluhkan user (FAQ) yang jumlahnya terbatas.

Quick Reference

Quick Reference berisi ringkasan informasi dari bagian kecil fungsi yang sering digunakan atau penting. ditujukan untuk Expert User.

User Guides

User Guides ditujukan unutk intermediate user. User guide harus memenuhi kebutuhan dari semua tipe user. Memperbolehkan user untuk melewati informasi yang sebelumnya telah diperoleh.

Online User Manual

Ada beberapa macam tipe manual untuk berbagai tipe user :

  1. Online Manual
  2. Online Help
  3. Context - Sensitive Help
  4. Online Tutorial & Animated Demonstration
  5. Online Communities, NewsGroups, E-mail, Chat, And Instant Messaging
  6. Online Help Principle & Guide Lines

Online Manual :

Kelebihan :

  • Secara fisik tidak banyak memakan tempat.
  • Mudah dinavigasikan.
  • Memberikan pengalaman yang interaktif pada user.
  • Secara ekonomi Lebih Hemat.

    Kekurangan :

  • User Interface mungkin menghambat.
  • Kesulitan navigasi.
  • Kesulitan melihat online manual.
  • Isi yang lebih sedikit.

Online Help

Bantuan yang disediakan oleh developer jika dalam manual online/paper tidak bisa menjawab pertanyaan user, atau juga bisa menghubungi costumer service dan admin.

Context - Sensitive Help

Sebuah icon yang bersimbolkan tanda tanya pada sebuah program yang berfungsi untuk menjelaskan icon yang sedang ditunjuk secara lebih rinci.

Online Tutorial & Animated Demonstration

kumpulan tata cara pengerjaan, dapat berupa video, text, online class dll. yaitu langkah - langkah yang disediakan oleh developer dalam suatu aplikasi untuk memudahkan user memahaminya.

Online Communities, NewsGroups, E-mail, Chat, And Instant Messaging

layanan yang tersedia diluar aplikasi tersebut, apabila dalam user manual ( offline ) tidak bisa menjawab pertanyaan, User dapat bertanya juga kepada layanan eksternal seperti grup aplikasi, dll.

Online Help Principle & Guide Lines :

  • Membuat menu/layanan help dengan tata letak yang mudah dilihat oleh pengguna.
  • Membuat secara lengkap dan akurat.
  • Menyediakan beberapa cara untuk mengaksesnya.
  • Membuat help yang berkaitan dengan user’s task dan user’s goal.
  • Sediakan beberapa level penjelasan untuk berbagai keadaan pada user.
  • Mudah dipelajari dan dinavigasikan.
  • Desain layout yang menarik.
  • Menggunakan Windowing / kotak dialog.

Online Documentation VS Paper Documentation :

Online Documentation :

Kelebihan :

  • Secara Fisik tidak memakan tempat.
  • Mudah dinavigasikan.
  • Dapat memberikan pengalaman interaksi pada User.
  • Secara Ekonomi lebih Hemat.

    Kekurangan :

  • Isi yang lebih Sedikit.
  • User interface yang mungkin menghambat user.
  • Kesulitan melihat Online Manuals.

    Paper Documentation :

    Kelebihan :

  • Secara fisik isi lengkap dan terperinci.
  • Mudah dalam pembacaannya, seperti mata tidak terhalang radiasi cahaya komputer, dll.
  • Tidak menggunakan jaringan internet karena menggunakan media kertas.

    Kekurangan :

  • Secara fisik memakan cukup ruang.
  • Harganya cukup mahal.
  • User experiencenya kurang menarik karena biasanya tidak ada animasi di dalamnya.

Sifat - Sifat User Dokumentasi :

  • Availability : User dapat menggunakan bantuan setiap saat selama sedang berinteraksi dengan sistem. User tidak perlu keluar dari aplikasi ketika ingin membuka aplikasi bantuan.
    Accuracy and Completeness : Bantuan seharusnya tersedia secara akurat dan lengkap.
  • Consistency : Konsistensi pada sistem yang ada, antara jenis online dan jenis tercetak, serta konsisten dari sisi content, terminologi dan bentuk presentasi.
  • Robustness : Kemampuan untuk melanjutkan operasi ketika sistem mempunyai perilaku yang tidak diharapkan.
  • Flexybility : membuat setiap user berinteraksi sesuai keinginannya.
    Unobtrusiveness : tidak mencegah user dalam melanjutkan pekerjaannya atau terpengaruh ddengan aplikasi user.

Tahapan Membuat User Dokumentasi yang baik :

  • Ease of Navigation.
  • Ease of Learning.
  • Ease of Reading.

Fungsi User Dokumentasi :

  • Memberikan kinerja sistem ( feedback ) yang baik untuk user.
  • Memberikan panduan interaksi antara pengguna dan sistem.
  • Memberikan panduan kepada pengguna untuk mempelajari sistem.
  • Memberikan panduan kepada pengguna untuk memecahkan masalah.

Manfaat User Dokumentasi :

  • Mengetahui dengan jelas alur pekerjaan dari sistem yang dibuat.
  • Bukti bahwa kita pernah melakukan developing dan perbaikan sistem.
  • Untuk mengatasi error dengan cepat.
  • Dapat meminimalisir kesalahan user dan menyediakan kemudahan recovery.
Bagikan