Cara Menulis Panduan Pengguna Perangkat Lunak: Panduan Utama (Termasuk Template)

Tidak yakin bagaimana menulis panduan pengguna perangkat lunak untuk produk Anda?

Jika Anda ingin membantu pengguna Anda mendapatkan nilai maksimal dari produk Anda dengan cara yang seefisien mungkin, membuat panduan pengguna perangkat lunak yang berkualitas adalah tempat yang tepat untuk memulai.

Dengan memberi pengguna konten yang mereka butuhkan untuk mempelajari dan memecahkan masalah produk Anda sendiri, Anda dapat membantu mereka sukses tanpa harus menghubungi saluran dukungan manusia Anda.

Ini tidak hanya mempermudah pengguna Anda, tetapi juga dapat mengurangi permintaan dukungan di bisnis Anda, yang menghemat waktu dan uang Anda.

Jadi – bagaimana Anda bisa membuat panduan pengguna perangkat lunak yang sempurna untuk pengguna Anda? Itulah tujuan dari panduan ini.

Untuk membantu Anda bangun dan berlari, inilah semua yang akan kami bahas di pos ini:

• Apa manual pengguna perangkat lunak itu
• Cara menulis panduan pengguna perangkat lunak dalam empat langkah, termasuk templat panduan pengguna perangkat lunak
• Praktik terbaik untuk membuat konten berkualitas tinggi untuk panduan pengguna Anda

Mari menggali!

Apa itu Panduan Pengguna Perangkat Lunak?

Panduan pengguna perangkat lunak adalah dokumentasi yang memberikan informasi tentang cara menggunakan dan mengelola aplikasi atau produk perangkat lunak Anda.

Panduan pengguna perangkat lunak Anda dapat menyertakan panduan memulai, petunjuk, glosarium, tip pemecahan masalah, dan jenis konten serupa lainnya.

Pada dasarnya, ini mencakup semua informasi yang dibutuhkan pengguna Anda untuk mendapatkan nilai dari perangkat lunak Anda.

Biasanya, ini akan dimulai dengan langkah-langkah penginstalan, kemudian mencakup ikhtisar umum antarmuka dan cara menggunakan berbagai fitur, lalu menggali pemecahan masalah dan FAQ jika diperlukan. Sekali lagi, kami akan membagikan template panduan pengguna perangkat lunak yang lebih mendetail di bawah ini.

Untuk melihat contoh manual pengguna perangkat lunak, Anda dapat melihat Manual Pengguna Forklift 3, yang langsung masuk ke penjelasan antarmuka.

Sebagai contoh lain, Anda dapat melihat konten Memulai Slack, yang juga langsung menjelaskan antarmuka Slack.

Mengapa Penting Membuat Panduan Pengguna Perangkat Lunak?

Ada dua alasan utama untuk membuat manual pengguna perangkat lunak untuk produk Anda:

1. Pengalaman pengguna yang ditingkatkan – dengan memudahkan pengguna mempelajari cara menggunakan perangkat lunak Anda dan memaksimalkan nilai yang mereka terima dari perangkat lunak Anda, pengguna Anda akan memiliki pengalaman yang lebih baik.
2. Mengurangi beban dukungan – dengan memberi pengguna kemampuan untuk memecahkan masalah mereka sendiri, Anda dapat mengurangi beban pada saluran dukungan manusia Anda. Ini terutama berlaku jika Anda menggabungkan panduan pengguna Anda dengan jenis konten pendukung lainnya seperti basis pengetahuan dan/atau pertanyaan umum (FAQ).

Cara Menulis Panduan Pengguna Perangkat Lunak dalam Empat Langkah

Sekarang, mari masuk ke panduan langkah demi langkah umum tentang cara menulis panduan pengguna perangkat lunak. Di bagian selanjutnya, kami juga akan membahas beberapa praktik terbaik untuk konten sebenarnya di panduan pengguna Anda.

Jika Anda tertarik untuk melihat topik ini secara lebih umum, kami juga memiliki panduan tentang cara membuat semua jenis panduan pengguna.

1. Rencanakan Struktur Panduan Pengguna Perangkat Lunak Anda

Sebelum Anda mulai membuat konten apa pun untuk manual Anda, pertama-tama Anda ingin memetakan struktur manual Anda dengan benar.

Untuk membuat manual Anda sekomprehensif mungkin, Anda mungkin ingin menyatukan beberapa pemangku kepentingan utama untuk membantu Anda melakukannya.

Misalnya, ini dapat mencakup kesuksesan pelanggan, penjualan, dan sebagainya – siapa saja yang memiliki pengetahuan tentang cara membantu pengguna mendapatkan nilai sebanyak mungkin dari produk. Dalam beberapa kasus, Anda juga mungkin perlu membawa lebih banyak staf teknis untuk membantu detail lebih lanjut.

Tentu saja, jika Anda menjalankan proyek solo, Anda akan memakai semua topi ini sendiri. Itulah kegembiraan menjadi pendiri tunggal.

Setelah Anda memiliki pemegang pengetahuan yang relevan, Anda dapat membuat garis besar panduan pengguna Anda.

Untuk template panduan pengguna perangkat lunak kasar, Anda dapat mengikuti sesuatu seperti ini…

1. Daftar isi – cantumkan bagian yang berbeda dalam panduan pengguna Anda sehingga pengguna tahu apa yang diharapkan.
2. Pendahuluan – jelaskan tujuan manual pengguna perangkat lunak Anda.
3. Persyaratan sistem – merinci persyaratan khusus apa pun yang dibutuhkan orang untuk menggunakan perangkat lunak Anda, seperti spesifikasi perangkat keras, sistem operasi, dll.
4. Petunjuk penginstalan – mencakup bagaimana pengguna dapat menginstal perangkat lunak.
5. Ikhtisar antarmuka pengguna – berikan ikhtisar antarmuka tingkat tinggi.
6. Cara menggunakan fitur khusus – buat bagian untuk setiap fitur inti yang menunjukkan kepada pengguna cara kerjanya.
7. Pertanyaan yang sering diajukan – mencakup beberapa pertanyaan umum yang mungkin dimiliki pengguna.
8. Pemecahan masalah – bagikan saran pemecahan masalah.
9. Glosarium – jika perangkat lunak Anda memiliki terminologi khusus, Anda mungkin ingin menambahkan glosarium di dekat akhir panduan pengguna perangkat lunak Anda.
10. Detail kontak dukungan – jelaskan bagaimana pengguna dapat menghubungi dukungan jika mereka membutuhkan bantuan tambahan. Anda ingin menyimpan ini di bagian akhir sehingga pengguna mencoba membantu diri mereka sendiri sebelum menghubungi dukungan.

Anda tidak harus mengikuti template panduan pengguna perangkat lunak ini dengan tepat – ini hanyalah titik awal untuk memberi Anda gambaran tentang apa yang mungkin ingin Anda sertakan.

2. Buat Konten Panduan Pengguna Perangkat Lunak Anda

Setelah Anda memiliki garis besar, Anda siap untuk mulai membuat konten manual pengguna perangkat lunak Anda.

Sebagian besar konten Anda akan berupa teks, tetapi jangan lupa untuk menyertakan juga gambar, GIF, dan video yang relevan.

Meskipun langkah ini mungkin memakan waktu paling lama, kami membuat bagian ini singkat untuk saat ini karena, di bagian berikutnya, kami akan membagikan beberapa praktik terbaik panduan pengguna perangkat lunak untuk membantu tim Anda membuat konten panduan pengguna yang efektif.

Siapa yang menulis konten Anda akan bergantung pada ukuran organisasi Anda dan kompleksitas produk Anda. Jika Anda tidak memiliki staf penulis teknis khusus, Anda mungkin perlu menugaskan konten ke tim sukses pelanggan atau tim teknis Anda, bergantung pada kerumitan perangkat lunak Anda.

Atau, jika Anda seorang pendiri tunggal, Anda mungkin akan menjadi orang terbaik untuk menulis konten manual karena Anda memiliki pemahaman terdalam tentang konten Anda. Anda selalu dapat menyewa editor untuk membantu menyempurnakan draf pertama Anda.

3. Publikasikan Panduan Pengguna Perangkat Lunak Anda

Setelah Anda memiliki konten untuk manual pengguna perangkat lunak Anda, Anda perlu menerbitkan manual Anda dengan cara yang memungkinkan pengguna dengan mudah menggunakannya.

Sebagian besar perangkat lunak basis pengetahuan atau dokumentasi harus berfungsi dengan baik untuk manual pengguna perangkat lunak, meskipun Anda selalu dapat mengkodekan solusi Anda sendiri jika merasa terlalu terbatas. Beberapa bisnis juga menerbitkan versi PDF dari panduan pengguna selain versi web.

Untuk melihat beberapa opsi hebat untuk memublikasikan versi web panduan pengguna perangkat lunak Anda, Anda dapat melihat daftar perangkat lunak berbasis pengetahuan terbaik dan alat dokumentasi terbaik kami.

Jika Anda mencari perangkat lunak panduan pengguna yang memberi Anda daftar fitur yang solid, kepemilikan penuh atas konten Anda, dan fleksibilitas untuk menyesuaikan hal-hal dengan kebutuhan Anda, Anda dapat menggunakan plugin WordPress Basis Pengetahuan Heroic kami.

Heroic Knowledge Base adalah perangkat lunak sumber terbuka yang memperluas sistem manajemen konten (CMS) WordPress sumber terbuka serupa dengan semua fungsi yang Anda perlukan untuk menerbitkan panduan pengguna perangkat lunak Anda.

Anda akan memiliki kepemilikan penuh atas platform Anda, ditambah fleksibilitas untuk menyesuaikan setiap elemen sesuai kebutuhan. Tetapi pada saat yang sama, Basis Pengetahuan Heroic masih menyertakan fungsionalitas bawaan untuk semua fitur penting yang dibutuhkan panduan pengguna perangkat lunak Anda:

• Organisasi artikel – Anda dapat mengatur artikel di manual perangkat lunak menggunakan kategori. Misalnya, Anda dapat memiliki kategori berbeda untuk "Instalasi", "Antarmuka", "Menggunakan Fitur", "Pemecahan Masalah", dan sebagainya.
• Fitur penemuan konten – untuk membantu pengguna menemukan konten yang relevan secepat mungkin, Heroic Knowledge Base menyertakan fitur penemuan konten yang bermanfaat seperti saran pencarian waktu nyata, daftar isi otomatis, dan banyak lagi.
• Sistem umpan balik pengguna – pengguna dapat berbagi umpan balik tentang kegunaan setiap artikel, yang memberi tahu Anda apa yang Anda lakukan dengan baik (dan di mana Anda perlu meningkatkan).
• Analitik terperinci – Anda dapat melacak artikel mana yang paling banyak dilihat, artikel mana yang paling banyak mendapat permintaan dukungan manusia, istilah apa yang dicari pengguna, pencarian mana yang tidak memberikan hasil apa pun, dan banyak lagi.

4. Perbarui Panduan Pengguna Perangkat Lunak Anda Berdasarkan Umpan Balik dan Perubahan

Membuat manual pengguna perangkat lunak yang berkualitas bukanlah hal yang "sekali dan selesai". Setelah Anda menerbitkan manual Anda, penting untuk tetap menugaskan pemangku kepentingan utama untuk memperbarui dan merevisi manual Anda sesuai kebutuhan.

Dalam beberapa kasus, pembaruan ini mungkin diperlukan karena adanya perubahan pada perangkat lunak Anda. Misalnya, jika Anda menambahkan fitur baru atau mengubah antarmuka perangkat lunak, Anda harus memperbarui panduan pengguna untuk memperhitungkan perubahan tersebut.

Dalam kasus lain, pembaruan ini dapat muncul dari umpan balik pengguna. Misalnya, jika Anda melihat pengguna bingung dengan artikel tertentu, Anda dapat memperbarui artikel tersebut agar lebih bermanfaat.

Atau, jika Anda melihat bahwa pengguna menelusuri topik yang tidak ada dalam panduan pengguna perangkat lunak, Anda mungkin perlu membuat artikel baru untuk membahas topik tersebut.

Menerbitkan panduan pengguna Anda dengan alat seperti Heroic Knowledge Base akan memudahkan Anda melacak jenis analitik ini sehingga Anda dapat memantau dan meningkatkan konten panduan pengguna Anda.

Praktik Terbaik untuk Menulis Panduan Pengguna Perangkat Lunak Anda

Sekarang setelah Anda memahami proses dasar tentang cara menulis panduan pengguna perangkat lunak, mari kita bahas beberapa praktik terbaik untuk membuat konten panduan pengguna yang efektif.

Pahami Siapa Audiens Anda

Jika Anda ingin membuat konten panduan pengguna yang bermanfaat, penting untuk mengetahui untuk siapa Anda menulis:

• Dari mana pengguna Anda berasal.
• Apa yang ingin mereka capai dengan perangkat lunak Anda.
• Poin nyeri apa yang mereka alami.
• Tingkat pengetahuan umum mereka tentang industri Anda dan/atau bidang teknis yang relevan.
• Di perusahaan mana mereka bekerja (atau jika mereka adalah pengguna tunggal).
• Dll.

Misalnya, perangkat lunak Anda berurusan dengan Salesforce. Jika pengguna target Anda adalah administrator Salesforce yang berpengalaman, konten Anda akan terlihat sangat berbeda dibandingkan jika pengguna target Anda adalah tenaga penjualan itu sendiri.

Anda mungkin sudah memiliki pemahaman yang baik tentang pengguna target Anda dari pekerjaan Anda saat ini. Namun, jika Anda tidak yakin, Anda dapat menggunakan persona pelanggan, survei, dan wawancara untuk mendapatkan pemahaman yang lebih dalam.

Gunakan Struktur Logis dan Organisasi

Kita telah membahasnya pada langkah pertama di bagian sebelumnya, tetapi penting untuk mengatur panduan pengguna Anda dengan cara yang optimal untuk memudahkan pengguna mendapatkan nilai dari konten Anda.

Ada berbagai cara untuk mengatur manual pengguna Anda, dan Anda dapat menggunakan beberapa pendekatan di bagian yang berbeda:

• Pengalaman linier – Anda dapat mengatur manual Anda dengan cara di mana pengguna akan mengalami berbagai hal. Misalnya, Anda mungkin memulai dengan "Instalasi" sebagai bagian pertama dan kemudian melanjutkan ke tindakan pertama setelah penginstalan di bagian berikutnya.
• Fitur – Anda dapat mengatur konten manual Anda berdasarkan berbagai fitur di perangkat lunak Anda.
• Pemecahan masalah – Anda dapat mengumpulkan langkah pemecahan masalah umum di satu tempat.

Sekali lagi, tidak apa-apa menggunakan beberapa pendekatan dalam manual Anda. Misalnya, Anda mungkin mulai dengan mengatur berbagai hal secara linier untuk proses instalasi.

Namun begitu Anda telah membahas penginstalan dan pengguna dapat mulai menerapkan perangkat lunak Anda dengan cara yang berbeda, Anda dapat beralih ke pendekatan organisasi berbasis fitur.

Buatlah Tulisan Anda Sederhana dan Konsisten

Untuk membuat panduan pengguna perangkat lunak Anda semudah mungkin diakses, penting untuk membuat tulisan Anda sesederhana mungkin.

Berikut adalah beberapa hal yang perlu diingat untuk mewujudkannya:

• Jangan gunakan jargon atau kata-kata yang membingungkan – tidak semua pengguna Anda akan memiliki pengetahuan yang sama mengenai industri Anda dan/atau bahasa produk Anda, jadi penting untuk menghindari jargon teknis yang tidak perlu dan kosa kata yang membingungkan. Anda dapat menguji konten Anda dengan alat seperti uji Flesch Reading Ease untuk menemukan masalah.
• Hindari suara pasif – menggunakan suara pasif bisa sangat membingungkan dalam panduan pengguna. Misalnya, daripada menggunakan suara pasif seperti “Menyimpan salinan draf Anda dapat dilakukan dengan menekan tombol Simpan Draf ”, lebih baik menggunakan suara aktif seperti “Tekan tombol Simpan Draf untuk menyimpan salinan draf Anda draf."
• Gunakan kalimat pendek – memecah konten Anda menjadi kalimat pendek memudahkan pengguna untuk membaca dan memindai konten panduan pengguna Anda. Jika memungkinkan, hindari paragraf panjang (AKA "dinding teks").
• Tetap konsisten – menggunakan kata-kata dan pemformatan yang konsisten akan memudahkan pengguna untuk memahami manual Anda. Misalnya, jika Anda selalu menggunakan daftar urutan untuk mencantumkan langkah-langkah individual dalam tugas tertentu, coba pertahankan pemformatan tersebut di seluruh manual pengguna Anda.
• Hindari masalah dengan tata bahasa – pastikan Anda tidak memiliki kesalahan tata bahasa yang dapat mempersulit pengguna untuk memahami manual Anda. Anda dapat memeriksanya menggunakan alat seperti Grammarly dan Hemingway.

Sertakan Gambar dan Video Jika Bermanfaat

Meskipun konten teks akan menjadi dasar panduan pengguna Anda, penting juga untuk menyertakan gambar dan video jika masuk akal.

Ungkapan bahwa "sebuah gambar bernilai seribu kata" mungkin terdengar klise, tetapi itu pasti benar ketika Anda mencoba menjelaskan bagaimana pengguna dapat memperoleh nilai dari produk perangkat lunak Anda.

Untuk membantu menjelaskan konsep dari teks Anda, Anda dapat menambahkan gambar beranotasi atau GIF yang menunjukkan apa yang Anda bicarakan.

Sebagai contoh, Slack melakukan pekerjaan yang baik untuk membuat anotasi gambar pengantar antarmuka.

Konten video juga dapat bermanfaat bagi sebagian pengguna. Namun, Anda harus berhati-hati untuk hanya mengandalkan konten video, karena ini tidak selalu merupakan cara yang optimal bagi pengguna untuk mengonsumsi konten manual perangkat lunak.

Misalnya, jika pengguna hanya mencoba memecahkan masalah detail tertentu, biasanya lebih mudah bagi mereka untuk menemukan detail tersebut di konten teks daripada di video.

Buat Panduan Pengguna Perangkat Lunak Anda Sekarang

Itu mengakhiri panduan kami tentang cara menulis panduan pengguna perangkat lunak hebat yang akan membuat pengguna Anda sukses.

Jika Anda menginginkan cara termudah untuk menerbitkan manual pengguna perangkat lunak Anda, Anda dapat menggunakan plugin Heroic Knowledge Base untuk WordPress.

Heroic Knowledge Base adalah plugin sumber terbuka yang memungkinkan Anda memanfaatkan CMS WordPress untuk membuat manual pengguna perangkat lunak yang dihosting sendiri yang sepenuhnya berada di bawah kendali Anda.

Pada saat yang sama, Anda tidak perlu mengorbankan fungsionalitas karena Heroic Knowledge Base menawarkan semua fitur yang Anda perlukan untuk membuat panduan pengguna perangkat lunak yang hebat. Fitur-fitur tersebut termasuk saran pencarian langsung, organisasi kategori, pengumpulan umpan balik pengguna, analitik, dan banyak lagi.

Jika Anda siap untuk memulai, beli Heroic Knowledge Base hari ini dan Anda akan segera memiliki panduan pengguna yang menarik.