Cara Menulis Manual Pengguna yang Jelas dan Ringkas
Apakah manual pengguna?
Terdapat pelbagai nama untuk manual pengguna. Dokumen teknikal, manual penyelenggaraan dan manual arahan adalah semua nama yang merujuk kepada item yang sama. Manual pengguna dibuat untuk membantu pelanggan menggunakan produk atau perkhidmatan anda dengan betul atau menyelesaikan isu yang berlaku semasa penggunaan. Ia boleh disediakan dalam bentuk cetak, digital atau kedua-dua format.
Manual penggunaan menyediakan pengguna akhir dengan arahan langkah demi langkah yang komprehensif dan beberapa sokongan untuk masalah. Jadual kandungan perlu ada dalam setiap manual pengguna kerana ia adalah bahan rujukan dan bukannya buku yang harus dibaca dari awal hingga akhir. Anda harus menambah tutorial permulaan pantas atau permulaan dalam manual pengguna anda supaya pengguna boleh berasa selesa mula menggunakan produk.
jenis manual pengguna
Untuk pelbagai subjek dan objektif, manual pengguna boleh dihasilkan. Berikut ialah beberapa kemungkinan anda, jadi mari kita lihatnya.
- Manual Arahan
Manual arahan ialah sejenis panduan pengguna yang menawarkan arahan mudah untuk menggunakan produk mengikut cara ia bertujuan untuk digunakan. - Manual Latihan
Panduan pengguna jenis ini menawarkan senarai garis panduan untuk menyelesaikan tugas, projek atau kerja tertentu. - Manual Servis
Manual servis ialah panduan pengguna yang menerangkan cara menjaga dan menyelenggara sesuatu mesin atau peralatan pada s yang berbezatages jangka hayatnya. - Manual Pengguna
Manual pengguna ialah penerbitan teknikal yang menerangkan cara menggunakan atau mengendalikan produk dengan betul. - Manual Operasi
Peranan, tugas dan prosedur khusus untuk perniagaan atau organisasi diterangkan dalam manual operasi. - Manual Dasar Organisasi
Manual dasar organisasi ialah dokumentasi yang mentakrifkan dasar, amalan dan amalan terbaik syarikat. - Manual Prosedur Operasi Standard (SOP).
Pengguna mendapat manfaat daripada arahan terperinci manual prosedur operasi standard untuk menjalankan prosedur yang ditetapkan.
Mengapa perniagaan anda memerlukan manual pengguna?
Orang ramai lebih bersedia untuk menangani masalah sendiri dengan sokongan manual pengguna. Manual pengguna yang baik mungkin memberi pelanggan anda alat yang mereka perlukan untuk mencapai nilai yang mereka inginkan dengan pantas dan berkesan daripada produk atau perkhidmatan anda dalam budaya kepuasan segera hari ini.
Perkhidmatan pelanggan yang cemerlang perlu ditambah dengan manual pengguna. Menulis manual pengguna yang sangat baik akan menyediakan advan berikuttages untuk syarikat anda:
- Untuk menjadikan onboarding dan latihan lebih mudah
Panduan pengguna yang ditulis dengan baik boleh menjadikan prosedur onboarding dan latihan lebih mudah. Itu betul, dengan membangunkan dan melaksanakan manual pengguna yang terkemuka, kedua-dua pekerja anda dan pengguna anda akan mendapat keuntungan.
Syarikat anda boleh menggunakan panduan pengguna untuk membantu pekerja baharu melalui beberapa proses dan sistem yang merupakan sebahagian daripada peranan baharu mereka dan bukannya hanya menyediakan sesi latihan bersemuka yang sukar, yang mempunyai perbelanjaan masa dan kewangan yang besar. Oleh kerana pekerja boleh belajar semasa menjalankan tugas yang berkaitan dengan jawatan mereka kerana panduan pengguna, mungkin terdapat kurang jam yang hilang semasa onboarding. - Untuk Mengurangkan Perbelanjaan Sokongan
Panduan pengguna ialah tambahan yang bagus kepada usaha perkhidmatan pelanggan anda untuk pengguna, tetapi ia juga berfungsi kepada pemilik perniagaan sebagai komponen sistem sokongan pelanggan.
Pelanggan lebih berkemungkinan mencari penyelesaian dengan segera dan kurang berkemungkinan perlu menghubungi juruteknik atau wakil untuk mendapatkan sokongan khusus apabila anda memberi mereka akses pantas kepada panduan pengguna yang boleh dicari. - Untuk menjimatkan masa
Kedua-dua pelanggan anda dan pekerja anda, daripada kakitangan peringkat permulaan kepada pengurusan, boleh menjimatkan masa dengan menggunakan manual pengguna. Apabila manual pengguna tersedia kepada pelanggan anda, mereka tidak perlu membuang masa untuk mencari maklumat tentang cara menggunakan produk kerana mereka akan mempunyai akses terus kepada maklumat tersebut dengan serta-merta.
Apabila pekerja anda dilengkapi dengan manual pengguna yang berguna, mereka tidak perlu membuang masa secara bebas mencari penyelesaian atau memonopoli perhatian rakan sekerja dan pengurus mereka dengan pertanyaan kerana mereka mempunyai akses kepada penyelesaian terus dalam manual pengguna mereka! - Untuk Meminimumkan Liabiliti
Satu pendekatan untuk menunjukkan bahawa anda telah menguji produk anda dengan teliti dan mengetahui cara menggunakannya dengan selamat adalah dengan menulis dan mengedarkan manual pengguna. Ini boleh mengurangkan dengan ketara sebarang kewajipan yang berkaitan dengan menghasilkan sesuatu untuk orang awam.
Mempunyai amaran dan langkah berjaga-jaga keselamatan yang ditulis dan boleh diakses oleh pengguna melalui panduan pengguna adalah cara yang berkesan (walaupun tidak mudah) untuk mengelakkan masalah undang-undang yang berkaitan dengan kecederaan atau kerosakan lain yang disebabkan oleh penyalahgunaan jika produk yang anda jual boleh berbahaya kepada pengguna (fikirkan pemanas ruang, alat kuasa, dsb.).
Apakah komponen yang membentuk manual pengguna terbaik?
Terdapat beberapa amalan terbaik dokumentasi pengguna akhir untuk dipatuhi walau apa pun, walaupun setiap produk adalah unik dan memerlukan komponen yang berbeza untuk menjana dokumentasi pengguna yang benar-benar cemerlang.
- Bahasa biasa
Tiada apa-apa yang akan lebih menggusarkan pelanggan anda—selain daripada tidak menawarkannya—daripada mendapati manual pengguna mereka penuh dengan jargon dan bahasa yang sukar difahami. Arahan pengguna anda sukar digunakan kerana pilihan bahasa ini, yang juga tidak mempromosikan perkhidmatan pelanggan yang cemerlang. Memastikan anda menulis untuk pengguna, bukan pembangun, adalah komponen penting untuk mencipta panduan pengguna yang hebat. Jangan menganggap bahawa pengguna akhir anda tahu atau biasa dengan apa-apa. Akronim, jargon dan istilah pejabat akan membuatkan pelanggan anda berasa salah maklumat, kecewa dan tidak bersedia. Tempat yang menarik untuk menghasilkan manual pengguna adalah menyeimbangkan antara tidak menulis seolah-olah pengguna anda adalah kanak-kanak (melainkan, sudah tentu, mereka!) dan memberi mereka bantuan tambahan yang mereka perlukan untuk memahami sepenuhnya cara menggunakan produk, secara ringkas. bahasa. - Kesederhanaan
Menulis buku panduan pengguna memerlukan perkara yang mudah. Konsep ini harus dicerminkan dalam kedua-dua kandungan dan reka bentuk. Jika anda melebihkan dokumentasi anda dengan gambar yang rumit dan petikan teks yang panjang, ia akan kelihatan terlalu canggih dan sukar untuk difahami. Manual pengguna jenis ini berkemungkinan menakutkan pengguna anda dan mendorong mereka menghubungi talian bantuan anda dan bukannya cuba menyelesaikan masalah mereka sendiri. - Visual
Pepatah "Tunjukkan, jangan beritahu" adalah asas penulisan manual pengguna. Tangkapan skrin beranotasi, filem dan kandungan visual lain sangat membantu dalam memahami konsep. Ia selalunya lebih berguna untuk melihat sesuatu dalam tindakan daripada membaca tentangnya. Visual bukan sahaja memecahkan petikan teks yang panjang, tetapi juga mengurangkan jumlah teks dalam manual pengguna yang boleh menakutkan. Telah ditunjukkan bahawa orang mengekalkan maklumat visual 7% lebih cepat daripada maklumat bertulis. Dalam kajian Techsmith, ia juga menunjukkan bahawa 67% orang melakukan tugas dengan lebih berkesan apabila diberi arahan yang termasuk tangkapan skrin beranotasi dan bukannya perkataan sahaja untuk menyampaikan maklumat. - Fokus pada masalah yang hendak diselesaikan
Besar kemungkinan seseorang membeli produk anda untuk menangani isu. Adalah penting untuk kekal fokus pada isu ini semasa mendraf manual pengguna yang akan disertakan dengan produk. Daripada menyenaraikan dan membincangkan semua ciri yang ditawarkan oleh produk anda atau elemen reka bentuk yang menarik yang telah anda serapkan, maklumkan kepada pengguna anda tentang ciri tersebut dengan cara yang memudahkan penggunaan produk. Letakkan masalah yang diselesaikan dalam konteks ciri dan faedah produk anda apabila menerangkannya. - Aliran logik dan hierarki
Untuk menjelaskan kepada pengguna perkara yang akan mereka pelajari daripada setiap bahagian manual pengguna anda, gunakan pengepala dan subtajuk yang mengikut struktur hierarki yang jelas. Untuk memimpin pelanggan anda dengan mudah melalui semua yang mereka perlu tahu dari awal hingga akhir, hierarki yang anda pilih harus mengikut aliran yang logik. Pastikan anda bermula dengan asas dan menggabungkan perkembangan logik ke arah ciri produk anda yang lebih canggih. - Senarai kandungan
Panduan pengguna anda akan sangat membantu pembaca jika ia bermula dengan jadual kandungan. Tanpa perlu menyelongkar banyak halaman maklumat yang tidak berkaitan dengan masalah semasa yang mereka hadapi, pendekatan biasa bagi seseorang untuk meneroka dokumen dengan cepat dan mudah. - Jadikan ia boleh dicari
Walaupun anda mungkin mencetak manual pengguna anda, kemungkinan besar dokumentasi digital akan menjadi keutamaan utama anda. Besar kemungkinan bahawa manual pengguna anda akan digunakan paling kerap dalam format digital di dunia di mana majoriti orang mempunyai telefon pintar dengannya pada setiap masa. Menambah ciri yang boleh dicari pada manual pengguna digital anda akan mempromosikan kemudahan penggunaan yang menarik untuk pengguna yang ingin menyelesaikan isu dengan mengaksesnya, sama seperti cara jadual kandungan berfungsi untuk mengarahkan pengguna ke tempat yang betul dalam dokumen cetakan. - Kebolehcapaian
Ada kemungkinan bahawa sesetengah orang yang memerlukan manual pengguna anda boleh mendapat manfaat daripada bantuan tambahan untuk memastikan ia berfungsi dengan baik. Tidak kira sama ada ia dikehendaki oleh undang-undang, keperluan kebolehaksesan secara amnya adalah amalan yang baik. Mengekalkan keperluan kebolehaksesan dalam manual pengguna anda hanyalah amalan perniagaan yang sangat baik. Mereka bentuk panduan pengguna dengan kandungan yang boleh diakses untuk pengguna yang mungkin menghadapi cabaran visual, boleh didengar atau kognitif adalah penting. - Direka dengan baik
Pertimbangkan khalayak anda semasa membuat panduan pengguna anda. Mereka akan lebih cenderung untuk menggunakannya dengan berkesan jika anda membuat sesuatu yang mereka suka melihat! Elakkan menggunakan blok teks yang panjang dan sediakan banyak ruang kosong. Menggabungkan kedua-dua ciri ini boleh membantu pengguna kelihatan kurang menakutkan dan menjadikan pembelajaran sesuatu yang baharu kelihatan menarik dan bukannya mengancam. Pendekatan "tunjukkan, jangan beritahu" yang kami nyatakan sebelum ini juga terpakai di sini. Untuk manual pengguna cetakan dan digital, menambah visual dan foto pada teks adalah alternatif yang hebat. Untuk manual pengguna digital, video dan GIF menawarkan minat dan elemen yang berguna. Jika syarikat anda mempunyai panduan gaya, reka bentuk anda harus mengikutinya; sebaliknya, jika anda beroperasi tanpa satu, adalah penting untuk memastikan panduan pengguna anda konsisten. Skema fon dan warna yang digunakan di seluruh kertas, dan sebaik-baiknya merentasi semua panduan pengguna anda, harus konsisten. - Komen daripada pelanggan sebenar atau penguji beta
Anda tidak akan dapat menentukan sama ada panduan pengguna yang telah anda sediakan berjaya atau tidak sehingga anda telah mencari dan mendengar maklum balas daripada orang yang benar-benar akan menggunakan produk anda. Panduan pengguna yang anda bangunkan untuk produk anda harus mengambil kira masalah yang dihadapi oleh orang ramai dengannya. Anda mungkin mempelajari sesuatu yang kelihatan sangat jelas, tetapi terdapat peluang yang lebih baik untuk anda mempelajari sesuatu yang akan membantu anda memahami keperluan pelanggan yang anda cuba capai.
Bagaimanakah saya menulis manual pengguna?
Membuat manual pengguna ialah tugas penting yang boleh memberi impak besar kepada kedua-dua syarikat anda dan pengguna yang ingin anda layani. Kami telah memudahkan proses membangunkan manual pengguna supaya anda boleh mengikutinya dengan mudah kerana ia boleh menjadi sangat menggembirakan.
- Kenal pasti pengguna
Mencari penerima komunikasi anda ialah langkah awal yang penting, sama seperti mana-mana komunikasi lain yang anda hasilkan. Khalayak sasaran manual pengguna anda akan membantu anda memutuskan isu seperti nada, tahap perincian untuk diberikan dan cara menyampaikan kandungan. Menulis panduan pengguna untuk pengguna akhir produk anda adalah jauh berbeza daripada menulis panduan untuk jurutera teknologi. Langkah pertama ialah menentukan khalayak anda. - Fokus pada masalah ini
Manual pengguna dibuat untuk membantu menyelesaikan masalah atau mengarahkan seseorang tentang cara melakukan sesuatu yang baharu. Anda mesti menentukan dengan tepat apa yang manual pengguna anda ingin lakukan dan pastikan untuk mengekalkan fokus tersebut.
Ia boleh menggoda untuk meluaskan topik dan membincangkan pelbagai ciri atau aplikasi untuk produk anda. Ini mungkin mengecewakan pengguna dan membawa kepada panggilan ke talian sokongan pelanggan anda dengan mengaburkan jawapan tulen yang mereka perlukan.
Jika pelanggan anda ialah pengguna yang belajar cara menggunakan produk atau juruteknik yang perlu membetulkannya, tumpukan perhatian pada penyelesaian tepat yang mereka perlukan. - Gunakan pendekatan berurutan
Arahan manual pengguna anda hendaklah dibentangkan dalam susunan berurutan yang diperlukan untuk menyelesaikan kerja di tangan. Senaraikan setiap langkah untuk bermula. Kemudian, berusaha untuk melakukan tugasan sambil mematuhi langkah-langkah tepat yang telah anda gariskan dalam susunan yang diberikan. Semasa anda menelusuri senarai asal anda, ada kemungkinan, bahkan mungkin, anda akan menemui sebarang stages yang tiada. Selain itu, anda mungkin mendapati bahawa sesuatu yang anda pernah percaya sebagai satu tugasan sebenarnya perlu dibahagikan kepada beberapa aktiviti untuk tujuan kejelasan.
Pastikan anda telah menentukan hasil yang jelas untuk setiap langkah berurutan yang telah anda peruntukkan sebelum beralih ke fasa seterusnya menulis panduan pengguna. Sebelum melangkah ke peringkat seterusnya, pembaca harus benar-benar jelas tentang apa yang mereka mahu capai dan bagaimana ia sepatutnya kelihatan. - Peta perjalanan pengguna
Memahami cara pengguna anda merancang untuk menggunakan produk anda dan memudahkan mereka berbuat demikian adalah matlamat untuk menghasilkan panduan pengguna. Anda mesti berusaha untuk memahami isu yang cuba diselesaikan oleh pengguna atau objektif yang mereka cuba capai dengan menggunakan penyelesaian anda, serta cara mereka terlibat dengan perniagaan anda. Anda boleh merancang langkah yang diperlukan untuk membimbing pelanggan melalui proses menggunakan butiran ini untuk menggambarkan perjalanan mereka dari masalah ke penyelesaian. - Pilih Templat
Tugas menulis dan membangunkan manual pengguna boleh dibuat lebih mudah daripada yang anda jangkakan dengan mencipta satu siri templat. Prosedur anda mungkin diperkemas, dan konsistensi akan menjadi objektif yang lebih realistik.
Dalam templat manual pengguna anda, selain mentakrifkan butiran seperti fon (jenis dan saiz), keperluan kontras dan skema warna, anda juga harus memasukkan perkara berikut:- Kawasan yang diperuntukkan untuk pengenalan
- Subseksyen dan bahagian yang berbeza
- Format pilihan anda untuk menyampaikan satu siri tindakan
- Nota amaran dan amaran
- Kawasan yang diperuntukkan untuk kesimpulan
- Tulis kandungan yang ringkas dan mudah diikuti
Bahan manual pengguna anda hendaklah semudah dan mudah difahami seboleh mungkin. Adalah penting untuk memikirkan dan menganalisis format dan kandungan untuk kejelasan dan kemudahan.
Pastikan setiap fasa proses hanya menggariskan satu tugasan dan menggunakan bahasa yang jelas dan singkat yang boleh. Pastikan anda mengubah suai teks anda dengan betul sehingga anda mempunyai manual pengguna yang mengandungi hanya maklumat yang benar-benar diperlukan. - Dekati setiap pengguna seperti orang baru
Anggapkan bahawa pembaca manual pengguna anda tidak mempunyai pengetahuan awal tentang produk anda semasa menciptanya. Tulis seolah-olah anda bercakap dengan orang awam.
Sebarang penggunaan jargon atau bahasa teknikal harus dielakkan. Sememangnya, akan ada masanya ia mesti dielakkan, tetapi ini harus menjadi pengecualian mutlak. - Uji arahan produk dengan pengguna baru
Fasa ujian proses penciptaan manual pengguna adalah penting. Subjek eksperimen mempunyai kesan yang signifikan terhadap hasilnya.
Ujian sebaiknya dilakukan ke atas orang yang tidak pernah menggunakan produk anda atau melihat dokumentasi. Semasa anda bergerak melalui manual pengguna, tonton mereka semasa mereka menyelesaikan proses dan rekod tempat ia tersekat. Kemudian, maklumat perlu dikemas kini dengan sewajarnya.
Hanya bantuan manual pengguna yang diperlukan untuk penguji anda mengendalikan produk. Mereka tidak perlu meminta lebih banyak bantuan. Panduan USSR harus mempunyai semua maklumat yang mereka perlukan. - Bina kandungan menggunakan pendekatan praktikal
Segala usaha harus dilakukan untuk menawarkan bekas konkritamples dan penerangan terperinci tentang sebarang hasil yang mungkin dialami pengguna selepas mengikut setiap langkah dalam manual pengguna. Pengguna harus mengetahui apa-apa maklum balas yang mungkin mereka peroleh daripada produk, serta sebarang potensi pemandangan atau bunyi yang mungkin mereka hadapi sepanjang perjalanan. - Terangkan simbol, ikon dan kod awal
Anda mungkin perlu menggunakan ikon, simbol atau kod semasa menulis manual pengguna untuk membantu memberikan arahan yang diperlukan. Untuk mengelakkan kekeliruan atau kekecewaan pembaca, adalah penting untuk mengenal pasti perkara ini seawal mungkin dalam manual pengguna anda.
Soalan Lazim manual pengguna
Apakah sebenarnya manual pengguna?
Dokumentasi pengguna ialah maklumat yang disediakan dalam bentuk manual pengguna atau panduan pengguna dan bertujuan untuk membantu pengguna akhir berinteraksi dengan produk dengan jayanya.
- Apakah jenis dokumentasi pengguna yang ada?
Dokumentasi fizikal, seperti buku kecil atau manual, secara tradisinya digunakan untuk menawarkan dokumentasi pengguna. Hari ini, manual pengguna dihasilkan dan diedarkan dengan lebih kerap secara digital. - Apakah yang terkandung dalam manual pengguna?
Manual arahan atau panduan pengguna menggunakan reka bentuk yang baik, tulisan yang jelas dan fokus penyelesaian masalah. Saya mesti mempunyai jadual kandungan, mematuhi hierarki dan aliran logik, dan menawarkan kandungan yang boleh diakses. Selain itu, manual pengguna yang baik boleh dicari dan mengambil kira semula penggunaviews. - Bagaimanakah dokumen pengguna dibuat?
Langkah mudah boleh digunakan untuk membangunkan manual pengguna. Objektif panduan pengguna mesti ditentukan terlebih dahulu, dan strategi mesti dibangunkan untuk membolehkan pencapaian mereka. Manual pengguna mesti diuji dan dikemas kini mengikut keperluan sebelum diterbitkan. Akhir sekali, adalah penting untuk memastikan panduan pengguna dikemas kini, membuat perubahan apabila kemas kini atau edisi baharu ditambahkan.