Cara Menulis Manual Pengguna yang Jelas dan Ringkas
Apa itu panduan pengguna?
Ada berbagai nama untuk manual pengguna. Dokumen teknis, manual perawatan, dan manual instruksi semuanya adalah nama yang mengacu pada item yang sama. Panduan pengguna dibuat untuk membantu pelanggan menggunakan produk atau layanan Anda dengan benar atau menyelesaikan masalah yang terjadi selama penggunaan. Mereka mungkin tersedia dalam bentuk cetak, digital, atau keduanya.
Panduan penggunaan memberi pengguna akhir petunjuk langkah demi langkah yang komprehensif dan beberapa dukungan untuk masalah. Daftar isi harus ada di setiap panduan pengguna karena merupakan bahan referensi daripada buku yang harus dibaca dari awal hingga akhir. Anda harus menambahkan tutorial mulai cepat atau memulai dalam panduan pengguna sehingga pengguna dapat dengan mudah merasa nyaman untuk mulai menggunakan produk.
macam manual pengguna
Untuk berbagai mata pelajaran dan tujuan, manual pengguna dapat diproduksi. Berikut adalah beberapa kemungkinan Anda, jadi mari kita lihat.
- Manual Instruksi
Manual instruksi adalah jenis panduan pengguna yang menawarkan instruksi langsung untuk menggunakan produk dengan cara yang dimaksudkan untuk digunakan. - Panduan Pelatihan
Panduan pengguna semacam ini menawarkan daftar pedoman untuk menyelesaikan tugas, proyek, atau pekerjaan tertentu. - Buku Panduan Layanan
Manual servis adalah panduan pengguna yang menjelaskan cara merawat dan merawat mesin atau peralatan di waktu yang berbedatages dari umurnya. - Panduan Pengguna
Manual pengguna adalah publikasi teknis yang menjelaskan cara menggunakan atau mengoperasikan produk dengan benar. - Manual Operasional
Peran, tugas, dan prosedur khusus untuk bisnis atau organisasi dijelaskan dalam manual operasi. - Pedoman Kebijakan Organisasi
Manual kebijakan organisasi adalah dokumentasi yang mendefinisikan kebijakan, praktik, dan praktik terbaik perusahaan. - Manual Prosedur Operasi Standar (SOP).
Pengguna mendapat manfaat dari instruksi terperinci manual prosedur operasi standar untuk melaksanakan prosedur yang telah ditetapkan.
Mengapa bisnis Anda membutuhkan panduan pengguna?
Orang lebih siap untuk menangani masalah mereka sendiri dengan dukungan manual pengguna. Panduan pengguna yang layak dapat memberi pelanggan Anda alat yang mereka butuhkan untuk mencapai nilai yang mereka inginkan dari produk atau layanan Anda dengan cepat dan efektif dalam budaya kepuasan langsung saat ini.
Layanan pelanggan yang sangat baik perlu dilengkapi dengan manual pengguna. Menulis manual pengguna yang sangat baik akan memberikan advan berikuttages untuk perusahaan Anda:
- Untuk membuat orientasi dan pelatihan menjadi lebih sederhana
Panduan pengguna yang ditulis dengan baik dapat membuat prosedur orientasi dan pelatihan menjadi lebih sederhana. Itu benar, dengan mengembangkan dan menerapkan manual pengguna terbaik, baik karyawan maupun konsumen Anda akan memperoleh keuntungan.
Perusahaan Anda dapat menggunakan panduan pengguna untuk membantu karyawan baru melewati beberapa proses dan sistem yang merupakan bagian dari peran baru mereka daripada hanya mengatur sesi pelatihan tatap muka yang sulit, yang menghabiskan waktu dan biaya keuangan yang signifikan. Karena karyawan dapat belajar sambil menjalankan tugas yang terkait dengan posisi mereka berkat panduan pengguna, mungkin ada lebih sedikit jam yang hilang selama onboarding. - Untuk Mengurangi Biaya Dukungan
Panduan pengguna adalah tambahan yang bagus untuk upaya layanan pelanggan Anda bagi konsumen, tetapi mereka juga melayani pemilik bisnis dengan baik sebagai komponen sistem dukungan pelanggan.
Pelanggan lebih mungkin untuk segera menemukan solusi dan cenderung tidak perlu menghubungi teknisi atau perwakilan untuk dukungan khusus saat Anda memberi mereka akses cepat ke panduan pengguna yang dapat dicari. - Untuk menghemat waktu
Pelanggan dan karyawan Anda, mulai dari staf pemula hingga manajemen, dapat menghemat waktu dengan menggunakan panduan pengguna. Ketika manual pengguna tersedia untuk klien Anda, mereka tidak perlu membuang waktu untuk mencari informasi tentang cara menggunakan produk karena mereka akan memiliki akses langsung ke informasi tersebut dengan segera.
Ketika karyawan Anda dilengkapi dengan panduan pengguna yang berguna, mereka tidak perlu membuang waktu mencari solusi secara mandiri atau memonopoli perhatian rekan kerja dan manajer mereka dengan pertanyaan karena mereka memiliki akses ke solusi langsung di panduan pengguna mereka! - Untuk Meminimalkan Kewajiban
Salah satu pendekatan untuk menunjukkan bahwa Anda telah menguji produk Anda secara menyeluruh dan mengetahui cara menggunakannya dengan aman adalah dengan menulis dan mendistribusikan panduan pengguna. Ini secara signifikan dapat menurunkan kewajiban apa pun yang terkait dengan memproduksi sesuatu untuk masyarakat umum.
Memiliki peringatan dan tindakan pencegahan keselamatan yang ditulis dan dapat diakses oleh pengguna melalui panduan pengguna adalah cara yang efektif (walaupun tidak mudah) untuk menghindari masalah hukum terkait cedera atau kerusakan lain yang disebabkan oleh penyalahgunaan jika produk yang Anda jual dapat berbahaya bagi pengguna (pikirkan pemanas ruangan, perkakas listrik, dll.).
Komponen apa yang merupakan panduan pengguna terbaik?
Ada beberapa praktik terbaik dokumentasi pengguna akhir yang harus dipatuhi, apa pun yang terjadi, meskipun setiap produk unik dan memerlukan komponen berbeda untuk menghasilkan dokumentasi pengguna yang benar-benar luar biasa.
- Bahasa sederhana
Tidak ada yang lebih mengganggu pelanggan Anda—selain tidak menawarkannya—selain menemukan panduan pengguna mereka penuh dengan jargon dan bahasa yang sulit dipahami. Petunjuk pengguna Anda sulit digunakan karena pilihan bahasa ini, yang juga tidak mempromosikan layanan pelanggan yang luar biasa. Memastikan Anda menulis untuk pengguna, bukan pengembang, adalah komponen penting dalam membuat panduan pengguna yang hebat. Jangan berasumsi bahwa pengguna akhir Anda mengetahui atau memahami apa pun. Akronim, jargon, dan terminologi kantor akan membuat klien Anda merasa salah informasi, frustrasi, dan tidak siap. Titik manis untuk membuat panduan pengguna adalah keseimbangan antara tidak menulis seolah-olah konsumen Anda adalah anak-anak (kecuali, tentu saja, mereka!) dan memberi mereka bantuan ekstra yang mereka butuhkan untuk benar-benar memahami cara menggunakan produk, secara sederhana bahasa. - Kesederhanaan
Menulis buku pegangan pengguna membutuhkan menjaga hal-hal sederhana. Konsep ini harus tercermin dalam konten dan desain. Jika Anda memenuhi dokumentasi Anda dengan gambar yang rumit dan bagian teks yang panjang, itu akan tampak terlalu rumit dan sulit untuk dipahami. Panduan pengguna semacam ini cenderung mengintimidasi pengguna Anda dan mengarahkan mereka untuk menghubungi saluran bantuan Anda daripada mencoba mencari tahu masalahnya sendiri. - Visualisasi
Pepatah “Tunjukkan, jangan ceritakan” adalah landasan penulisan panduan pengguna. Tangkapan layar beranotasi, film, dan konten visual lainnya sangat membantu dalam memahami konsep. Seringkali jauh lebih berguna untuk melihat sesuatu dalam tindakan daripada membaca tentangnya. Visual tidak hanya memecah bagian teks yang panjang, tetapi juga mengurangi jumlah teks dalam manual pengguna yang bisa menakutkan. Telah dibuktikan bahwa orang menyimpan informasi visual 7% lebih cepat daripada informasi tertulis. Dalam studi Techsmith, juga ditunjukkan bahwa 67% orang melakukan tugas lebih efektif saat diberikan instruksi yang menyertakan tangkapan layar beranotasi daripada kata-kata saja untuk menyampaikan informasi.
- Fokus pada masalah yang akan dipecahkan
Sangat mungkin seseorang membeli produk Anda untuk mengatasi suatu masalah. Penting untuk tetap fokus pada masalah ini saat menyusun panduan pengguna yang akan disertakan dengan produk. Alih-alih menghitung dan mendiskusikan semua fitur yang ditawarkan produk Anda atau elemen desain menarik yang telah Anda sertakan, beri tahu pengguna Anda tentang fitur tersebut dengan cara yang memudahkan penggunaan produk. Tempatkan masalah yang dipecahkan dalam konteks fitur dan manfaat produk Anda saat mendeskripsikannya. - Aliran logis dan hierarki
Untuk memperjelas kepada pengguna apa yang akan mereka pelajari dari setiap bagian panduan pengguna Anda, gunakan tajuk dan subjudul yang mengikuti struktur hierarki yang jelas. Untuk mengarahkan pelanggan Anda dengan mudah melalui semua yang perlu mereka ketahui dari awal hingga akhir, hierarki yang Anda pilih harus mengikuti alur yang logis. Pastikan Anda memulai dengan dasar-dasar dan memasukkan perkembangan logis menuju fitur produk Anda yang lebih canggih. - Daftar isi
Panduan pengguna Anda akan sangat membantu pembaca jika dimulai dengan daftar isi. Tanpa harus menggali banyak halaman informasi yang tidak terkait dengan masalah saat ini yang mereka hadapi, itu adalah pendekatan yang biasa bagi seseorang untuk menjelajahi dokumen dengan cepat dan mudah. - Jadikan itu dapat dicari
Bahkan jika Anda dapat mencetak manual pengguna Anda, kemungkinan besar dokumentasi digital akan menjadi prioritas utama Anda. Kemungkinan besar panduan pengguna Anda akan paling sering digunakan dalam format digital di dunia di mana mayoritas orang selalu membawa ponsel cerdas. Menambahkan fitur yang dapat dicari ke manual pengguna digital Anda akan mempromosikan kemudahan penggunaan yang menyenangkan bagi pengguna yang ingin menyelesaikan masalah dengan mengaksesnya, serupa dengan bagaimana daftar isi berfungsi untuk mengarahkan pengguna ke tempat yang tepat dalam dokumen cetak. - Aksesibilitas
Ada kemungkinan beberapa orang yang memerlukan panduan pengguna Anda dapat memanfaatkan bantuan ekstra untuk memastikannya berfungsi dengan baik. Terlepas dari apakah mereka diwajibkan oleh undang-undang, persyaratan aksesibilitas umumnya adalah praktik yang baik. Mempertahankan persyaratan aksesibilitas dalam manual pengguna Anda hanyalah praktik bisnis yang sangat baik. Merancang panduan pengguna dengan konten yang dapat diakses oleh pengguna yang memiliki tantangan visual, suara, atau kognitif sangatlah penting. - Dirancang dengan baik
Pertimbangkan audiens Anda saat membuat panduan pengguna Anda. Mereka akan jauh lebih cenderung menggunakannya secara efektif jika Anda membuat sesuatu yang mereka sukai! Hindari penggunaan blok teks yang panjang dan sediakan banyak ruang putih. Menggabungkan kedua karakteristik ini dapat membantu konsumen tampak tidak terlalu menakutkan dan membuat mempelajari sesuatu yang baru tampak menarik daripada mengancam. Pendekatan “tunjukkan, jangan ceritakan” yang kami jelaskan sebelumnya juga berlaku di sini. Untuk manual pengguna cetak dan digital, menambahkan visual dan foto ke teks adalah alternatif yang bagus. Untuk manual pengguna digital, video dan GIF menawarkan minat dan elemen yang bermanfaat. Jika perusahaan Anda memiliki panduan gaya, desain Anda harus mengikutinya; jika tidak, jika Anda beroperasi tanpanya, sangat penting untuk menjaga konsistensi panduan pengguna Anda. Skema font dan warna yang digunakan di seluruh makalah, dan idealnya di seluruh panduan pengguna Anda, harus konsisten. - Komentar dari pelanggan aktual atau penguji beta
Anda tidak akan dapat menentukan apakah panduan pengguna yang Anda siapkan sesukses mungkin atau tidak sampai Anda mencari dan mendengarkan umpan balik dari orang-orang yang benar-benar akan menggunakan produk Anda. Panduan pengguna yang Anda kembangkan untuk produk Anda harus mempertimbangkan masalah yang dihadapi orang-orang. Anda mungkin mempelajari sesuatu yang tampaknya sangat jelas, tetapi ada peluang yang jauh lebih baik bahwa Anda akan mempelajari sesuatu yang akan membantu Anda memahami kebutuhan pelanggan yang ingin Anda jangkau.
Bagaimana cara menulis panduan pengguna?
Membuat panduan pengguna adalah tugas penting yang dapat berdampak besar bagi perusahaan Anda dan konsumen yang ingin Anda layani. Kami telah menyederhanakan proses pengembangan panduan pengguna sehingga Anda dapat dengan mudah mengikutinya karena dapat membuat Anda kewalahan.
- Mengidentifikasi pengguna
Menemukan penerima komunikasi Anda adalah langkah awal yang penting, sama seperti komunikasi lain yang Anda hasilkan. Audiens yang dimaksud dalam panduan pengguna Anda akan membantu Anda memutuskan masalah seperti nada, tingkat detail yang harus disediakan, dan cara menyampaikan konten. Menulis panduan pengguna untuk pengguna akhir produk Anda sangat berbeda dengan menulis panduan untuk teknisi teknologi. Langkah pertama adalah menentukan audiens Anda. - Fokus pada masalah
Manual pengguna dibuat untuk membantu memecahkan masalah atau menginstruksikan seseorang tentang cara melakukan sesuatu yang baru. Anda harus menentukan dengan tepat apa tujuan manual pengguna Anda dan pastikan untuk mempertahankan fokus itu.
Anda mungkin tergoda untuk memperluas topik dan mendiskusikan berbagai fitur atau aplikasi untuk produk Anda. Ini dapat membuat pengguna frustrasi dan menyebabkan panggilan ke saluran dukungan pelanggan Anda dengan mengaburkan jawaban asli yang mereka butuhkan.
Jika pelanggan Anda adalah konsumen yang mempelajari cara menggunakan produk atau teknisi yang perlu memperbaikinya, berkonsentrasilah pada solusi tepat yang mereka perlukan. - Gunakan pendekatan berurutan
Instruksi manual pengguna Anda harus ditata dalam urutan berurutan yang diperlukan untuk menyelesaikan pekerjaan yang ada. Buat daftar setiap langkah untuk memulai. Kemudian, usahakan untuk mengerjakan tugas sambil mengikuti langkah-langkah tepat yang telah Anda uraikan dalam urutan yang diberikan. Saat Anda melihat daftar asli Anda, mungkin, bahkan mungkin, Anda akan menemukan stages yang hilang. Selain itu, Anda mungkin menemukan bahwa sesuatu yang pernah Anda yakini sebagai satu tugas sebenarnya harus dibagi menjadi beberapa aktivitas demi kejelasan.
Pastikan Anda telah menentukan hasil yang jelas untuk setiap langkah berurutan yang telah Anda alokasikan sebelum melanjutkan ke fase berikutnya dalam menulis panduan pengguna. Sebelum melanjutkan ke tingkat berikutnya, pembaca harus benar-benar jelas tentang apa yang ingin mereka capai dan bagaimana tampilannya. - Petakan perjalanan pengguna
Memahami bagaimana konsumen Anda berencana untuk menggunakan produk Anda dan membuatnya mudah bagi mereka untuk melakukannya adalah tujuan dari pembuatan panduan pengguna. Anda harus berupaya memahami masalah yang coba dipecahkan oleh konsumen atau tujuan yang ingin mereka capai dengan menggunakan solusi Anda, serta bagaimana mereka terlibat dengan bisnis Anda. Anda dapat merencanakan langkah-langkah yang diperlukan untuk memandu pelanggan melalui proses menggunakan detail ini untuk memvisualisasikan perjalanan mereka dari masalah ke solusi. - Pilih Template
Tugas menulis dan mengembangkan manual pengguna dapat dibuat lebih sederhana dari yang Anda harapkan dengan membuat serangkaian template. Prosedur Anda mungkin disederhanakan, dan konsistensi akan menjadi tujuan yang jauh lebih realistis.
Di templat panduan pengguna Anda, selain menentukan detail seperti font (jenis dan ukuran), persyaratan kontras, dan skema warna, Anda juga harus menyertakan yang berikut ini:- Area yang dialokasikan untuk pengenalan
- Subbagian dan bagian yang berbeda
- Format yang Anda pilih untuk menyampaikan serangkaian tindakan
- Catatan peringatan dan peringatan
- Area yang dialokasikan untuk kesimpulan
- Tulis konten yang sederhana dan mudah diikuti
Materi panduan pengguna Anda harus sesederhana dan sesederhana mungkin untuk dipahami. Penting untuk memikirkan dan menganalisis format dan konten untuk kejelasan dan kenyamanan.
Pastikan bahwa setiap fase proses hanya menguraikan satu tugas dan menggunakan bahasa sejelas dan sesingkat mungkin. Pastikan untuk memodifikasi teks Anda dengan benar sampai Anda memiliki panduan pengguna yang hanya berisi informasi yang benar-benar diperlukan. - Dekati setiap pengguna seperti pemula
Asumsikan bahwa pembaca manual pengguna Anda tidak memiliki pengetahuan sebelumnya tentang produk Anda saat membuatnya. Tulislah seolah-olah Anda sedang berbicara dengan orang awam.
Segala penggunaan jargon atau bahasa teknis harus dihindari. Secara alami, akan ada saat-saat ketika itu harus dihindari, tetapi ini harus menjadi pengecualian mutlak. - Uji instruksi produk dengan pengguna pemula
Tahap pengujian proses pembuatan manual pengguna sangat penting. Subjek eksperimen memiliki dampak signifikan pada hasil.
Pengujian idealnya dilakukan pada orang yang belum pernah menggunakan produk Anda atau melihat dokumentasinya. Saat Anda menelusuri manual pengguna, perhatikan mereka saat mereka menyelesaikan proses dan catat di mana mereka macet. Kemudian, informasi harus diperbarui dengan tepat.
Hanya bantuan panduan pengguna yang diperlukan bagi penguji Anda untuk mengoperasikan produk. Mereka seharusnya tidak perlu meminta bantuan lebih lanjut. Panduan USSR harus memiliki semua informasi yang mereka butuhkan. - Bangun konten menggunakan pendekatan praktis
Setiap upaya harus dilakukan untuk menawarkan ex betonampfile dan deskripsi mendetail tentang hasil apa pun yang mungkin dialami pengguna setelah mengikuti setiap langkah dalam panduan pengguna. Pengguna harus mengetahui umpan balik apa pun yang mungkin mereka dapatkan dari produk, serta pemandangan atau suara potensial yang mungkin mereka temui di sepanjang jalan. - Jelaskan simbol, ikon, dan kode sejak dini
Anda mungkin perlu menggunakan ikon, simbol, atau kode saat menulis panduan pengguna untuk membantu memberikan instruksi yang diperlukan. Untuk mencegah kebingungan atau frustrasi pembaca, sangat penting untuk mengidentifikasi ini sedini mungkin dalam panduan pengguna Anda.
FAQ panduan pengguna
Apa sebenarnya manual pengguna itu?
Dokumentasi pengguna adalah informasi yang diberikan dalam bentuk manual pengguna atau panduan pengguna dan dimaksudkan untuk membantu pengguna akhir dalam berinteraksi dengan produk dengan sukses.
- Apa jenis dokumentasi pengguna yang ada?
Dokumentasi fisik, seperti buklet atau manual, secara tradisional telah digunakan untuk menawarkan dokumentasi pengguna. Saat ini, manual pengguna lebih sering diproduksi dan didistribusikan secara digital. - Apa yang terkandung dalam manual pengguna?
Manual instruksi atau panduan pengguna menggunakan desain yang baik, tulisan yang jelas, dan fokus pemecahan masalah. Saya harus memiliki daftar isi, mematuhi hierarki dan alur yang logis, dan menawarkan konten yang dapat diakses. Selain itu, panduan pengguna yang baik akan dapat dicari dan mempertimbangkan pengguna kembaliviews. - Bagaimana dokumen pengguna dibuat?
Langkah-langkah sederhana dapat digunakan untuk mengembangkan manual pengguna. Tujuan panduan pengguna pertama-tama harus ditentukan, dan strategi harus dikembangkan untuk memungkinkan pencapaiannya. Panduan pengguna harus diuji dan diperbarui seperlunya sebelum diterbitkan. Terakhir, penting untuk selalu memperbarui panduan pengguna, membuat perubahan saat pembaruan atau edisi baru ditambahkan.