Cara Membuat User Manual: From Zero to Hero (Panduan Lengkap)

Diterbitkan: 2022-11-24

Tidak yakin bagaimana cara membuat panduan pengguna untuk membantu pelanggan mendapatkan nilai lebih dari produk Anda?

Panduan pengguna adalah konten yang membantu pelanggan (atau karyawan) Anda menggunakan produk atau layanan Anda secara efektif. Anda juga mungkin melihatnya disebut panduan pengguna, manual instruksi, manual produk, dan sebagainya.

Selain membantu pelanggan menggunakan produk Anda secara efektif, membuat panduan pengguna berkualitas tinggi juga dapat membantu Anda mengurangi permintaan layanan dan dukungan pelanggan karena pengguna dapat menyelesaikan masalah mereka tanpa menghubungi dukungan.

Dalam panduan mendetail ini, Anda akan mempelajari cara membuat panduan pengguna yang membantu pelanggan mencapai kesuksesan.

Untuk mewujudkannya, inilah semua yang akan kami bahas:

  • Berbagai jenis manual pengguna
  • Di mana menerbitkan panduan pengguna Anda
  • Cara membuat panduan pengguna

Mari menggali!

Berbagai Jenis Manual Pengguna

Ada berbagai jenis panduan pengguna, termasuk konten yang menghadap pelanggan dan konten internal.

Sebelum memulai, penting untuk memahami jenis manual yang ingin Anda buat, karena hal itu akan memengaruhi cara Anda mendekati konten.

Berikut ringkasan singkat dari berbagai jenis manual pengguna:

  • Panduan pengguna – panduan pengguna klasik mengajarkan pengguna cara menggunakan suatu produk.
  • Manual pelatihan – manual pelatihan mengajarkan pengguna cara melakukan tugas tertentu atau menyelesaikan pekerjaan tertentu.
  • Manual operasi – manual operasi biasanya merupakan manual internal yang mendokumentasikan operasi perusahaan Anda.
  • Manual layanan – manual layanan berfokus pada mengajari pengguna cara merawat produk dengan benar di berbagai titik dalam siklus hidup produk.
  • Prosedur Operasi Standar (SOP) – SOP adalah manual internal yang mengajarkan anggota organisasi cara menyelesaikan proses tertentu dengan benar “dengan cara yang benar”.

Untuk petunjuk di bawah ini, kami terutama berfokus pada pembuatan panduan pengguna yang terbuka untuk umum. Namun, prinsip dasar di bawah ini berlaku untuk semua jenis panduan pengguna.

Di mana Menerbitkan Panduan Pengguna Anda

Di mana Anda menerbitkan panduan pengguna Anda akan bergantung pada jenis panduan pengguna yang Anda buat.

Untuk manual pengguna yang dihadapi pelanggan, Anda hampir selalu ingin menerbitkannya di situs web Anda. Dengan begitu, pengguna dapat mengakses manual dari mana saja.

Selain itu, memublikasikan konten panduan pengguna di web juga memungkinkan Anda menciptakan pengalaman yang lebih ramah pengguna dibandingkan dengan panduan pengguna fisik, seperti menambahkan daftar konten yang dapat diklik dan saran pencarian real-time.

Namun, untuk produk fisik, Anda mungkin juga ingin menyertakan manual pengguna fisik sebagai pendamping manual berbasis web Anda.

Untuk manual pengguna internal, biasanya Anda ingin menyembunyikannya dari tampilan publik.

Salah satu cara untuk melakukannya adalah dengan hanya membuatnya tersedia di intranet perusahaan. Namun, dengan begitu banyak orang yang bekerja dari rumah, hal ini sulit dilakukan kecuali perusahaan Anda memiliki penyiapan VPN sendiri.

Sebagai gantinya, Anda dapat mempertimbangkan untuk melindungi konten dengan kata sandi, baik dengan meminta karyawan untuk masuk ke akun pengguna atau hanya menambahkan kata sandi untuk mengakses halaman.

Untuk manual pengguna fisik, Anda dapat menggunakan alat manajemen pengetahuan khusus untuk membantu Anda menerbitkan manual yang lebih kompleks. Atau, untuk panduan pengguna yang lebih sederhana, Anda cukup menulis di Google Dokumen dan menerbitkan dari sana – koleksi alat tulis teknis kami memiliki beberapa alat berguna untuk membuat hidup Anda lebih mudah.

Untuk menerbitkan panduan pengguna Anda secara online, Anda dapat menggunakan sebagian besar perangkat lunak dokumentasi atau basis pengetahuan. Jika Anda menginginkan alat yang dapat menangani manual pengguna internal dan publik, Anda dapat mempertimbangkan plugin Heroic Knowledge Base open-source untuk WordPress. Kami akan membicarakan ini secara lebih mendalam di tutorial.

Berikut adalah contoh manual pengguna online dari Heroic Knowledge base (dan tentang Heroic Knowledge Base):

Ngomong-ngomong tentang tutorialnya…

Cara Membuat Panduan Pengguna Dalam Enam Langkah

Sekarang setelah Anda memiliki beberapa informasi latar belakang, mari kita masuk ke cara membuat panduan pengguna, mulai dari nol hingga menjadi panduan pengguna yang sudah jadi.

1. Buat Persona Pengguna Anda

Sebelum Anda mulai membuat konten apa pun, Anda ingin memahami untuk siapa konten itu, yang dapat Anda capai dengan membuat persona pengguna.

Anda mungkin sudah memiliki ide bagus tentang siapa pelanggan Anda, tetapi akan sangat membantu jika Anda menuliskannya untuk benar-benar memfokuskan upaya Anda.

Mengapa ini penting?

Nah, inilah contohnya:

Ada perbedaan besar antara membuat konten teknis untuk insinyur mesin dan membuat konten teknis untuk pengguna non-teknis.

Untuk sebagian besar produk, perbedaannya tidak terlalu mencolok. Namun tetap penting untuk memahami persona pelanggan Anda sehingga Anda dapat memastikan panduan pengguna Anda masuk akal bagi orang yang benar-benar akan menggunakannya.

2. Identifikasi Masalah Utama dan Sasaran

Setelah Anda memahami siapa pelanggan Anda, langkah selanjutnya adalah memahami apa yang ingin mereka capai dengan panduan pengguna yang akan Anda buat.

Artinya, apa tujuan akhir (atau tujuan akhir) dari orang-orang yang akan membaca manual ini?

Memahami hal ini penting karena tujuan manual Anda seharusnya untuk membantu pengguna Anda mencapai tujuan tersebut seefisien mungkin.

Dalam beberapa kasus, tujuan akhir ini mungkin merupakan hal yang spesifik. Misalnya, jika Anda memiliki alat manajemen media sosial, itu mungkin “menjadwalkan posting di media sosial”.

Di lain, itu mungkin tujuan yang lebih abstrak, seperti "meningkatkan proses manajemen proyek kami".

Untuk produk yang lebih besar, mungkin ada beberapa hal yang ingin dicapai oleh pengguna, yang membawa kita ke bagian selanjutnya.

3. Buat Struktur Logis dan Hirarki

Sekarang setelah Anda memahami siapa pelanggan Anda dan apa yang ingin mereka capai, Anda dapat mulai memetakan struktur panduan pengguna Anda.

Anda ingin membuat struktur yang akan membawa pengguna Anda dari "nol" untuk mencapai tujuan akhir yang Anda cantumkan di bagian sebelumnya.

Berikut adalah beberapa tips untuk membantu Anda melakukannya:

  1. Pikirkan tentang bagaimana membantu pelanggan mulai mendapatkan nilai dari produk Anda secepat mungkin.
  2. Keluarkan pengetahuan pribadi Anda sendiri darinya. Anda jelas tahu banyak tentang produk Anda, tetapi pelanggan Anda tidak akan memiliki latar belakang pengetahuan seperti itu.
  3. Pastikan untuk menutupi masalah umum atau detail membingungkan yang mungkin dihadapi pelanggan Anda saat mencoba menggunakan produk Anda. Ini harus ditangani secara logis pada saat pelanggan kemungkinan besar mengalami masalah.

4. Tulis Konten Panduan Pengguna Anda

Setelah Anda memetakan konten Anda, Anda siap untuk mulai menulis.

Bergantung pada ukuran produk/organisasi Anda, Anda dapat menulis semuanya sendiri. Atau, Anda mungkin perlu berkolaborasi dengan anggota tim lain untuk menulis konten.

Berikut adalah beberapa praktik terbaik panduan pengguna umum untuk dipertimbangkan saat menulis panduan pengguna Anda:

  • Gunakan template untuk memastikan pemformatan yang konsisten . Membuat template berformat tidak hanya mempercepat pekerjaan Anda, tetapi juga memastikan bahwa setiap artikel dalam manual Anda konsisten dengan yang lain.
  • Sertakan visual (gambar dan video) untuk membantu pengguna . Gambar atau GIF yang dianotasi dengan baik dapat lebih membantu daripada instruksi teks mandiri, tidak peduli seberapa detail dan menyeluruh teks tersebut.
  • Gunakan bahasa sederhana dan hindari jargon . Atau, ketika jargon benar-benar tidak dapat dihindari, pastikan untuk menjelaskannya.
  • Tetap pendek dan to the point . Tujuan Anda dengan manual pengguna harus mencakup topik sepenuhnya, tetapi dengan kata-kata sesedikit mungkin. Jangan tinggalkan informasi penting, tetapi potong konten yang tidak perlu dengan kejam.
  • Gunakan peluru dan daftar untuk instruksi bila memungkinkan . Menggunakan daftar bernomor atau berpoin dapat memudahkan pengguna untuk melacak panduan ini. Atau, jika Anda memerlukan lebih banyak detail daripada yang diizinkan oleh daftar, Anda dapat membuat setiap langkah menjadi subjudulnya sendiri.
  • Gunakan suara aktif . Suara pasif bisa sangat membingungkan untuk instruksi di manual pengguna. Inilah perbedaan antara “Produk dapat dihidupkan dengan menekan tombol merah” dan “Anda dapat menghidupkan produk dengan menekan tombol merah”. Contoh terakhir (suara aktif) lebih jelas dan memudahkan pembaca untuk menempatkan diri dalam instruksi.

Terakhir, selalu merupakan ide bagus untuk menguji instruksi manual pengguna Anda seolah-olah Anda adalah pengguna pertama kali.

Artinya, setelah Anda menulis artikel, kembali dan benar-benar mengikuti petunjuk langkah demi langkah untuk memastikan Anda tidak melewatkan apa pun.

5. Publikasikan Panduan Pengguna Anda

Setelah Anda memiliki konten, langkah terakhir untuk menayangkannya adalah menerbitkan panduan pengguna Anda agar mudah tersedia bagi pelanggan Anda.

Bagaimana Anda melakukannya tergantung pada jenis produk yang Anda tawarkan. Misalnya, Anda mungkin ingin menyertakan versi fisik manual jika Anda mengirimkan produk fisik.

Namun, apa pun jenis produk yang Anda tawarkan, Anda pasti ingin menerbitkan panduan pengguna Anda secara online sehingga orang dapat menemukannya dengan mudah.

Untuk membantu Anda melakukannya, Anda dapat menggunakan perangkat lunak basis pengetahuan/dokumentasi.

Misalnya, dengan plugin Heroic Knowledge Base WordPress, Anda dapat menerbitkan panduan pengguna menggunakan perangkat lunak WordPress sumber terbuka.

Pendekatan sumber terbuka ini memberi Anda kepemilikan dan kendali penuh atas platform Anda, sambil tetap menyediakan banyak alat yang berguna untuk membantu pelanggan menavigasi panduan pengguna Anda dengan lebih efektif:

  • Organisasi kategori – Anda dapat dengan mudah mengatur panduan pengguna Anda ke dalam kategori logis dan mengurutkan kategori tersebut menggunakan seret dan lepas.
  • Saran pencarian real-time – jika pelanggan ingin langsung menuju ke tutorial tertentu, mereka dapat mulai mengetik di pencarian dan melihat saran pencarian langsung berdasarkan permintaan mereka.
  • Daftar isi otomatis – plugin akan secara otomatis menghasilkan daftar isi yang dapat diklik untuk setiap artikel panduan pengguna, yang membantu pembaca langsung melompat ke bagian yang relevan bagi mereka.
  • Info/pemformatan yang mudah – Anda dapat dengan mudah menambahkan info dan pemformatan lainnya untuk menarik perhatian ke elemen utama dalam artikel Anda.
  • Widget jawaban instan – selain membuat halaman panduan pengguna khusus di situs Anda, Anda juga dapat menambahkan widget jawaban instan yang dapat ditelusuri yang memungkinkan pengunjung menjelajahi konten panduan pengguna dari mana saja di situs Anda.

Jika Anda ingin melihat lebih banyak opsi perangkat lunak untuk membantu Anda menerbitkan panduan pengguna, Anda dapat membaca postingan kami tentang perangkat lunak basis pengetahuan terbaik dan alat dokumentasi terbaik.

6. Perbarui dan Revisi Manual Pengguna Anda Sesuai Kebutuhan

Membuat panduan pengguna bukanlah upaya satu kali. Ke depan, Anda harus meluangkan waktu untuk merevisi dan memperbarui konten Anda.

Ada dua alasan utama mengapa Anda mungkin perlu memperbarui panduan pengguna Anda:

  1. Anda menambahkan fitur baru ke produk Anda atau mengubah cara kerja fitur/antarmuka yang ada.
  2. Anda ingin meningkatkan konten panduan pengguna agar lebih bermanfaat.

Situasi pertama sudah jelas – jika Anda mengubah produk Anda dengan cara tertentu, Anda perlu memperbarui panduan pengguna Anda untuk memperhitungkan perubahan tersebut.

Namun, situasi kedua juga penting untuk dipertimbangkan. Cobalah sekuat tenaga, Anda mungkin tidak akan mendapatkan setiap artikel panduan pengguna sempurna sejak hari pertama.

Untuk membantu pengguna dengan lebih baik, Anda dapat memperbarui dan merevisi konten manual berperforma rendah agar lebih bermanfaat.

Jika Anda menerbitkan panduan pengguna Anda dengan alat seperti Basis Pengetahuan Heroik, itu termasuk peringkat kebermanfaatan artikel bawaan sehingga Anda dapat dengan mudah melihat artikel mana yang perlu ditingkatkan. Pengguna juga dapat meninggalkan umpan balik teks pada artikel, yang dapat mengarahkan Anda ke bagian tertentu dari artikel yang tidak membantu sebanyak mungkin:

Anda juga mungkin melewatkan artikel untuk topik yang bermasalah dengan pengguna. Untuk membantu Anda menemukan topik yang hilang ini, Heroic Knowledge Base juga menyertakan analitik pencarian bawaan sehingga Anda dapat melacak pencarian mana yang tidak memiliki hasil topik apa pun ( serta keseluruhan pencarian secara umum ):

Buat Panduan Pengguna Anda Sekarang

Mempelajari cara membuat panduan pengguna penting jika Anda ingin menyiapkan pelanggan untuk sukses.

Dengan tips dan praktik terbaik dalam postingan ini, Anda seharusnya sekarang memiliki pengetahuan yang Anda perlukan untuk memulai dan menjalankan panduan pengguna Anda.

Untuk cara mudah menerbitkan manual pengguna Anda secara online dan membantu pelanggan Anda menavigasinya, Anda dapat menggunakan WordPress dan plugin Heroic Knowledge Base.

Basis Pengetahuan Heroic memudahkan untuk menerbitkan artikel Anda dan mengaturnya sesuai kebutuhan. Selain itu, pelanggan Anda dapat memanfaatkan fitur bermanfaat seperti saran pencarian langsung, daftar isi otomatis, dan banyak lagi.

Mulailah hari ini dan Anda akan menerbitkan panduan pengguna Anda dalam waktu singkat.

Jika Anda tertarik membuat dokumentasi untuk meningkatkan pengetahuan internal di bisnis Anda, Anda mungkin juga tertarik dengan tutorial kami tentang cara menerbitkan manual pelatihan untuk staf Anda.