10 Hal Penting dalam Pembuatan User Guide
Apa itu User Guide ?
Berdasarkan wikipedia, User Guide / Panduan Pengguna adalah suatu dokumen komunikasi teknis yang bertujuan untuk memberikan bantuan penggunaan suatu sistem, terutama dikaitkan dengan peranti elektronik serta perangkat keras dan lunak komputer. Manual biasanya ditulis oleh seorang penulis teknis atau biasa disebut technical writer.
Pada umumnya, manual pengguna mengandung panduan tertulis dan gambar terkait. Manual aplikasi komputer biasanya menyertakan cuplikan layar tampilan program, sedangkan manual perangkat keras umumnya menyertakan diagram yang jelas dan disederhanakan.
Berdasarkan penjelasan diatas, user guide terbagi menjadi dua, user guide untuk perangkat lunak & user guide untuk perangkat keras. Dalam Artikel ini penulis akan fokus membahas mengenai user guide / panduan pengguna untuk perangkat lunak. Berikut 10 hal penting dalam pembuatan User Guide yang perlu diketahui oleh seorang Technical Writer.
- Cover
Cover dibuat dengan desain yang menarik sesuai dengan target pembacanya. Harapannya user tertarik untuk membaca user guide. Berikut Contoh Cover user guide dari aplikasi Gojek dan Zoom
2. Daftar Isi
Berisi secara lengkap Bab dan Sub Bab yang terdapat pada user guide. Pada daftar isi, technical writer bisa membuatnya semenarik mungkin dan tidak kaku.
3. Desain Header & Footer
Desain header & footer dibuat sesuai dengan standar, yaitu meliputi logo client, versi aplikasi & numbering di footer
4. Executive Summary
Berisi informasi secara umum mengenai aplikasi dari latar belakang dan maksud tujuan dibuatnya aplikasi tersebut.
5. Glossary
Glossary berisi istilah — istilah yang spesifik ada pada aplikasi tersebut, tujuannya agar user baru tidak salah dalam memahami istilah di aplikasi. Berikut adalah contoh glossary dari aplikasi Quicktime Apple.
6. Capture UI
Hasil capture difokuskan pada konten, tidak perlu capture layar penuh pada setiap tahapan. Pada setiap capture ditambahkan juga penjelasan secara terperinci sebagai contoh berikut
7. Narasi
Setiap Bab dan SubBab harus ditambahkan narasi pendahuluan sebelum masuk ke tahapan fitur
8. User Guide dibuat per role
User guide di buat secara terpisah untuk setiap role pada aplikasi. User guide untuk role administrator, staff, manager, vp dll di buat dalam dokumen berbeda, karena nantinya akan disirkulasikan sesuai dengan tugas dan kewenangan di aplikasi.
9. Numbering & Heading
Gunakan tools numbering & heading otomatis agar dapat membuat daftar isi secara otomatis juga. Heading juga bisa dibuatkan lebih variatif dari segi warna dan jenis font
10. Perhatikan Bahasa
Hindari Bahasa yang terlalu teknis yang tidak dimengerti oleh orang non-teknis
Demikian beberapa hal penting yang bisa diperhatikan untuk meningkatkan kualitas user guide dari aplikasi yang disusun oleh seorang technical writer. Prinsip utama user guide adalah membuat orang yang belum kenal dengan aplikasi menjadi kenal dengan aplikasi dan menggunakannya setelah membaca user guide yang dibuat.
