Apa Itu User Documentation?

capture

Apa Itu User Documentation Itu ?

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 User Documentation

Jenis User Documentation terbagi menjadi dua yaitu :

  • Online User manual
  • Paper User manual

Yang Pertama, Online User manual

Online User manual meliputi :

  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.online
  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.
    • help
  3. Context-sensitive help
    • Yaitu Sebuah Icon yang bersimbolkan tanda tanya pada sebuah program yang fungsinya menjelaskan icon yang sedang ditunjuk secara lebih rinci.
    • capture
  4. Online tutorial &Animated demonstration
    • 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.
    • picture1
  5. Online communities, newsgroups, listservers, 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.
    • picture2

GUIDELINES pada Online Manual User

  1. membuat help selalu/mudah terlihat(visible)
  2. buat secara lengkap dan akurat
  3. sediakan beberapa cara untuk mengaksesnya
  4. buat help yang berkaitan dengan user’s task dan user’s goal
  5. sediakan beberapa level penjelasan untuk berbagai macam user
  6. buat help yang mudah dipelajari dan dinavigasikan
  7. sediakan desain layout yang menarik
  8. gunakan windowing/kotak dialog

Yang Kedua, Paper 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.

Paper User manual meliputi :

  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 tsbpicture3
  2. Reference Manuals
    • 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 sistempicture4
  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 sistempicture6

Online vs paper documentation

  1. Online
    1. Kelebihan
      • Secara Fisik Tidak Memakan Tempat
      • Mudah Dinavigasikan
      • Dapat Memberikan Pengalaman Interaksi Pada User
      • Secara Ekonomi Lebih Hemat
    2. Kekurangan
      • Kecenderungan user yang lebih suka membaca Paper
      • Isi yang Lebih Sedikit
      • User interface yang mungkin menghambat user
      • Kesulitan Melihat Online Manuals
  2. Paper
    1. Kelebihan
      • Secara fisik isi lengkap dan terperinci
      • Mudah dalam pembacaannya
      • Tidak menggunakan jaringan internet
    2. Kekurangan
      • Secara fisik memakan cukup ruang
      • Harga nya cukup mahal
      • User experiencenya kurang menarik karena biasanya tidak ada animasi di dalamnya

Sifat-sifat User Dokumentasi

  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.

Tahapan-tahapan dalam Membuat User Dokumentasi 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)

picture8picture9

  • 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

picture10picture7

  • Easof 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)

Fungsi user dokumentasi

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

Manfaat dari User Dokumentasi

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

Referensi

http://ayo-belajar-imk.blogspot.co.id/2014/02/user-documentation-and-online-help.html

https://anggimlr.wordpress.com/2014/06/13/user-documentation-and-online-help/

https://www.youtube.com/watch?v=fK8as_xHbiE

https://helpx.adobe.com/premiere-pro.html

https://helpx.adobe.com/support/premiere-pro.html

https://id.wikipedia.org/wiki/Halaman_Utama

https://egaighfar.wordpress.com/2016/07/27/user-documentation/

http://komponen-dasar-blog.blogspot.co.id/2008/07/cheat-sheet.html

http://www.digilife.be/quickreferences/quickrefs.htm

-http://www.doc-department.com/what-are-user-documentation-and-technical-documentation/

-Mayhew, Deborah J. 1992.Principle and guidelines in software user interface design.USA:PTR Prentice Hall

Skip to toolbar