Dokumentasi User dan Pertolongan Online

Paper versus Online Manuals

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

Online manuals 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 manuals juga memiliki beberapa kelemahan yaitu kecenderungan user yang lebih suka membaca paper manuals, isi yang lebih sedikit, user interface yang mungkin menghambat, kesulitan navigasi, dan kesulitan melihat online manuals.

Faktanya adalah bahwa orang - orang cenderung membaca 15% - 30% lebih lambat pada komputer dibandingkan membaca buku. Hal ini terutama dipengaruhi oleh font yang digunakan, resolusi layar, batas karakter yang tidak jelas, pencahayaan, pantulan, flicker pada layar, layout, dan hal - hal lainnya. Manual biasanya dapat memperpendek waktu belajar user, meningkatkan performa user, meningkatkan kepuasan user, dan mengurangi jumlah panggilan untuk support. Dalam hal ini ada sesuatu yang dikenal sebagai "active user paradox", yang merupakan kondisi dimana kebanyakan user memilih untuk tidak membaca manual dengan lengkap sehingga mereka hanya mengetahui hal - hal yang umum saja.

Berikut merupakan panduan dalam membuat suatu user manuall oleh Carroll:

1. Pilih pendekatan aksi2. Gunakan pekerjaan user sebagai panduan dalam mengorganisasikan manual3. Beri informasi mengenai pengenalan kesalahan dan recovery4. Beri informasi untuk praktik dan pembelajaran lebih lanjut

Hal - hal yang perlu diperhatikan untuk organisasi dan cara penulisan manual:

1. Kalimat yang tepat dan sesuai dengan tujuan edukasi2. Sajikan konsep dalam urut - urutan logis dan tingkat kesulitan bertahap dari mudah ke sulit3. Pastikan bahwa setiap konsep digunakan dalam bagian berikutnya4. Hindari referensi pada bab berikutnya5. Buat jumlah bab sesuai dengan materi yang disajikan6. Berikan contoh yang mencukupi7. Perhatikan pilihan kata8. Buat kerangka dulu untuk memastikan konsistensi dan kualitas9. Cara penulisan harus menyesuaikan dengan user

Online Manuals and Help

Berikut merupakan panduan dalam online help yang diajukan oleh Kearsley:

1. Buat agar help system mudah diakses dan mudah untuk keluar2. Buat help spesifik mungkin3. Kumpulkan data untuk menentukan help apa yang paling diperlukan4. Berikan user kontrol atas help system5. Buat pesan help seakurat dan selengkap mungkin6. Jangan gunakan help dengan tujuan untuk mengkompensasi interface yang buruk

Online manuals merupakan manual yang disediakan secara online. Dengan adanya online manuals user dapat dipermudah, karena ada fitur seperti multiple windows, text highlighting, warna, suara, animasi, dan fasilitas searching. Dalam membuat online manuals, daftar isi harus disediakan di salah satu sisi dan tetap terlihat selama fasilitas online manuals digunakan user.

Sementara itu online help lebih bersifat spesifik dengan tujuan tertentu. Selain itu user diharapkan mampu melakukan searching sendiri terhadap dokumen - dokumen online yang ditampilkan. Pada online help, kebanyakan memiliki wizard yang dapat merespons pada bahasa natural.

Online Tutorials, Demonstrations, and Animations

Dengan adanya tutorial online, user dapat membaca tutorial sekaligus materi yang diberikan. Selain itu user juga dapat bekerja sesuai kecepatannya dan tanpa rasa malu jika membuat kesalahan selama tutorial berlangsung. Demonstrations merupakan suatu demo yang memperlihatkan fitur - fitur suatu produk. Hal ini dibuat dengan tujuan menarik minat potential user dan membangun suatu product image yang positif. Biasanya didistribusikan lewat internet dalam bentuk CD-ROM atau DVD.

Development Process Guidelines

Berikut merupakan panduan dalam proses pembuatan manual:

1. Gunakan copywriter professional2. Siapkan dokumentasi jauh sebelumnya.3. Buat dokumen panduan yang terintegrasi4. Review draft terlebih dahulu5. Lakukan uji lapangan terhadap versi awal6. Berikan cara bagi user untuk memberikan feedback7. Lakukan revisi secara berkala