Cara Membuat Dokumentasi Pengguna Terbaik
Diterbitkan: 2021-12-21Kemungkinannya adalah jika produk Anda lebih kompleks daripada gulungan tisu, Anda membuat semacam dokumentasi pengguna untuk membantu orang mempelajari cara menggunakannya.
Manual produk atau panduan pengguna yang dibuat dengan baik dan ramah pengguna dapat berarti perbedaan antara pengalaman pelanggan yang fantastis dan pengalaman yang buruk.
Plus, dokumentasi pengguna tidak hanya untuk pengguna baru.
Pelanggan yang berpengalaman juga dapat merujuk ke manual pengguna atau panduan produk untuk menyegarkan ingatan mereka tentang fitur yang tidak sering mereka gunakan atau untuk memecahkan masalah tertentu yang mereka miliki.
Untuk posting ini, kami akan lebih fokus pada praktik terbaik untuk membuat dokumentasi pengguna untuk produk non-fisik seperti perangkat lunak, tetapi sebagian besar (jika tidak semua) tip ini juga berlaku untuk perangkat keras.
Inilah yang akan Anda pelajari:
- Apa itu dokumentasi pengguna dan mengapa itu penting.
- Bagaimana dokumentasi pengguna akhir merupakan bagian dari pengalaman pelanggan.
- Bagaimana dokumentasi pengguna yang baik dapat membantu meringankan beban tim dukungan pelanggan Anda.
- Mengapa konten visual adalah bahan rahasia untuk dokumentasi terbaik.
- Elemen penting yang memastikan dokumentasi pengguna terbaik.
- Empat langkah untuk membuat dokumentasi yang menyenangkan pelanggan Anda dan bertahan dalam ujian waktu.
Mudah membuat panduan pengguna (Templat Gratis)
Template Snagit adalah cara tercepat untuk membuat panduan pengguna. Buat panduan langkah demi langkah dengan tampilan sederhana dan profesional.
Unduh
Apa itu dokumentasi pengguna?
Dokumentasi pengguna (juga disebut manual pengguna akhir, panduan pengguna akhir, manual instruksi, dll.) adalah konten yang Anda berikan kepada pengguna akhir untuk membantu mereka menjadi lebih sukses dengan produk atau layanan Anda.
Ini adalah materi instruksional yang menyertai produk Anda untuk membantu seseorang belajar menggunakannya dengan benar atau — dalam kasus produk fisik — bahkan merakitnya.
Jika Anda pernah menyusun perabot IKEA, Anda telah menggunakan dokumentasi pengguna akhir.
Namun, dokumentasi pengguna mengambil banyak bentuk.
Video game dilengkapi dengan manual untuk memberi tahu Anda tombol mana yang harus ditekan untuk menembak orang jahat. Dokumentasi perangkat lunak menunjukkan kepada Anda apa yang dapat dilakukan pembelian Anda dan bagaimana melakukannya.
Formulir pajak dilengkapi dengan panduan tentang cara mengisinya dengan benar.
Mesin pemotong rumput dan peniup salju memiliki panduan produk untuk menunjukkan kepada Anda cara menghidupkan mesin dan di mana mengisi bahan bakar.
Lewati ke cara membuat dokumentasi pengguna
Mengapa dokumentasi pengguna penting?
Anda tahu produk Anda hebat. Anda ingin pelanggan Anda mengetahuinya juga. Dokumentasi pengguna membantu memastikan pelanggan atau pengguna Anda benar-benar mempelajari cara memaksimalkan produk Anda.
Baik itu cara menyimpan dokumen, menyalakan mesin, menggunakan alat tertentu, atau bahkan informasi keselamatan penting, dokumentasi pengguna akhir Anda adalah bagian penting dari hubungan Anda dengan pelanggan.
Dokumentasi pengguna dapat menyenangkan pelanggan Anda
Dokumentasi pengguna mudah, bukan? Maksud saya, cukup tulis beberapa hal tentang cara menggunakan produk Anda, dan Anda siap melakukannya!
Ini tidak sesederhana itu.
Ini lebih dari sekadar materi "bagaimana caranya". Itu bagian dari pengalaman pelanggan. Dan itu berarti juga materi pemasaran.
Sebagai konsumen sendiri, saya telah mengalami panduan pengguna yang hebat dan mengerikan. Saya yakin sebagian besar dari Anda memiliki pengalaman serupa.
Panduan pengguna atau panduan produk yang bagus menunjukkan kepada pelanggan Anda bahwa Anda tidak hanya peduli tentang apakah mereka membeli produk Anda, tetapi apakah mereka benar-benar memiliki pengalaman hebat dalam menggunakannya.
Pelanggan yang merasa bahwa Anda peduli dengan mereka di luar dompet mereka akan terus datang kembali kepada Anda.
Jika Anda ingin mereka berteriak kepada dunia tentang betapa mereka menyukai produk dan layanan Anda, menyediakan dokumentasi pengguna yang luar biasa adalah bagian penting dari pengalaman pasca-pembelian itu.
Bagaimana dokumentasi pengguna mendukung tim dukungan Anda
Orang-orang sering menghubungi tim dukungan Anda ketika sesuatu tidak berfungsi, tetapi mereka mungkin juga menelepon ketika mereka tidak dapat menemukan sesuatu. Memiliki dokumentasi pengguna yang hebat membantu tim dukungan Anda dalam dua cara utama.
1. Memberi mereka panduan referensi yang mudah
Dokumentasi pengguna yang bagus tidak hanya untuk pelanggan. Tim dukungan produk Anda dapat menggunakan dokumentasi untuk membantu mendukung pelanggan Anda dengan lebih baik saat mereka meminta bantuan. Saat Anda menyertakan bagian penting, seperti daftar isi atau indeks, mereka dapat dengan cepat menemukan informasi yang mereka butuhkan. Dan, jika itu adalah dokumen elektronik yang dapat dicari, itu lebih baik! Kita akan mempelajari lebih lanjut tentang ini nanti di artikel.
2. Mengurangi panggilan
Seperti disebutkan di atas, orang sering menelepon dukungan ketika mereka tidak dapat menemukan sesuatu. Namun, jika pelanggan dapat mengetahuinya sendiri, kemungkinan kecil mereka membutuhkan bantuan. Faktanya, lebih dari 70 persen orang lebih suka menggunakan situs web perusahaan untuk mendapatkan bantuan daripada mendapatkan bantuan melalui telepon atau email.
Bahkan dokumentasi terbaik tidak akan menghilangkan semua panggilan ini, tetapi membuat panduan pengguna dan manual yang jelas, komprehensif, dan ringkas akan sangat membantu mengurangi volume keseluruhan permintaan dukungan.
Apa elemen penting dari dokumentasi pengguna yang hebat?
Meskipun setiap produk unik dan akan memerlukan elemen yang berbeda untuk membuat dokumen pengguna yang benar-benar hebat, ada beberapa praktik terbaik dokumentasi pengguna akhir yang harus diikuti, apa pun yang terjadi.
Dokumentasi pengguna yang bagus harus mencakup:
- Bahasa sederhana
- Kesederhanaan
- visual
- Fokus pada masalah
- Hirarki dan aliran logis
- Sebuah daftar isi
- Konten yang dapat dicari
- Konten yang dapat diakses
- Desain yang bagus
- Umpan balik dari pengguna nyata
- Tautan ke sumber daya lebih lanjut
Bahasa sederhana
Tidak ada yang akan membuat pelanggan lebih frustrasi daripada membaca sesuatu yang tidak mereka mengerti. Tidak ada yang ingin merasa bodoh, dan bahasa yang membuat pelanggan Anda merasa seperti itu tentu saja bukan cara untuk menumbuhkan pengalaman hebat.
Gunakan bahasa yang sederhana dan sederhana bila memungkinkan untuk membantu pelanggan Anda memahami konsep yang paling rumit sekalipun.
Ingat, menulis untuk pengguna, bukan pengembang.
Kedengarannya seperti mudah, tetapi menulis dalam bahasa sederhana tentang produk atau layanan yang Anda tahu dari depan ke belakang lebih sulit daripada yang Anda kira. Anda tahu semua jenis jargon, akronim, dan info "orang dalam" lainnya yang kemungkinan besar tidak diketahui pelanggan. Itu wajar bagi Anda untuk menggunakannya.
Tapi di situlah Anda bisa mengalami masalah serius.
Jangan berasumsi bahwa pelanggan Anda tahu apa-apa tentang produk Anda. Jangan berasumsi bahwa mereka mengetahui semua istilah teknis dan/atau industri yang mungkin Anda gunakan setiap hari di dalam kantor Anda.
Jangan menulis seolah-olah mereka anak-anak, tetapi pahamilah bahwa mereka mungkin memerlukan bantuan ekstra untuk benar-benar mempercepatnya. Tulis dokumentasi dengan cara yang mudah dibaca.
Kesederhanaan
Buat dokumentasi sesederhana mungkin untuk mencapai tujuannya. Ini berlaku baik untuk konten dokumen maupun desainnya. Blok teks dan halaman yang panjang yang dikemas dengan konten tertulis dan grafis dapat membuat panduan pengguna atau manual terasa menakutkan dan tidak ramah.
Pelanggan yang terintimidasi oleh materi pengguna Anda jauh lebih mungkin untuk menghubungi tim dukungan Anda untuk meminta bantuan daripada mencoba memecahkan pertanyaan mereka sendiri. Selain itu, mereka jauh lebih kecil kemungkinannya untuk memiliki pengalaman pelanggan yang baik.
visual
Dokumentasi pengguna terbaik dengan sempurna mengilustrasikan frasa, “tunjukkan, jangan beri tahu.”
Konten visual, termasuk gambar, tangkapan layar beranotasi, grafik, dan video, dengan cepat menunjukkan kepada seseorang cara kerja produk Anda. Mereka tidak perlu membacanya: mereka bisa melihatnya!
Penelitian terbaru dari TechSmith menunjukkan bahwa orang benar-benar menyerap informasi visual lebih cepat dan melakukan tugas lebih baik ketika instruksi diberikan dengan konten visual atau video.
Konten visual juga membantu memecah blok teks yang panjang dan dapat membantu menghilangkan banyak teks yang membuat banyak panduan pengguna atau manual terasa menakutkan dan tidak menyenangkan.
Cara populer untuk memasukkan konten visual dalam dokumentasi pengguna termasuk tangkapan layar, rekaman layar, video tutorial, dan banyak lagi.
Pernahkah Anda mendengar tentang grafik yang disederhanakan? Kadang-kadang disebut antarmuka pengguna yang disederhanakan (atau SUI), grafik yang disederhanakan mengambil gambar dari antarmuka pengguna atau grafik lainnya dan — seperti namanya — menyederhanakannya. Versi yang lebih mendasar ini menyoroti informasi yang paling penting sekaligus mengurangi teks dan grafik yang tidak penting menjadi bentuk yang lebih sederhana.
Jadi, sesuatu yang terlihat seperti ini:
Sekarang terlihat seperti ini:
Jika saya mencoba menunjukkan kepada seseorang cara memilih item menu Hubungkan Perangkat Seluler, gambar kedua menghilangkan semua kekacauan dan memungkinkan mata pelanggan untuk fokus di tempat yang seharusnya.
Kemungkinan Anda telah menemukan grafik yang disederhanakan dan bahkan tidak menyadarinya, seperti yang ini dari Pusat Pembelajaran G Suite:
Ada banyak alat di luar sana, tetapi jika Anda mencari cara yang kuat dan mudah untuk membuat tangkapan layar dan rekaman layar, saya sangat merekomendasikan mengunduh uji coba gratis Snagit.
Fokus pada masalah yang akan dipecahkan
Setiap produk memecahkan masalah. Tetapi terlalu sering, kami sangat menyukai fitur produk keren kami sehingga yang ingin kami lakukan hanyalah menyoroti apa yang dapat dilakukannya daripada mengapa pelanggan kami membutuhkannya.
Pastikan untuk menunjukkan kepada pengguna cara melakukan tugas dengan produk Anda.
Secara alami, ini akan melibatkan fitur produk, tetapi soroti dalam konteks membantu pengguna memahami alasan mereka membeli produk Anda — untuk memecahkan masalah tertentu.
Misalnya, tutorial Camtasia dan Snagit kami (ya, video tutorial dapat menjadi bentuk dokumentasi) menyoroti fitur tertentu, tetapi mereka melakukannya dalam konteks mengapa seseorang mungkin menggunakan fitur tertentu. Ini tentang mengapa, bukan hanya bagaimana.
Berikut adalah contoh yang bagus…
Hirarki dan aliran logis
Dokumentasi yang baik membutuhkan hierarki heading dan subheading yang memungkinkan pengguna mengetahui apa yang akan ditunjukkan oleh setiap bagian kepada mereka. Dan hierarki itu harus mengikuti alur logis yang membantu pengguna belajar menggunakan produk Anda dengan cara yang paling membantu.
Misalnya, Anda mungkin tidak ingin memulai dokumentasi dengan menunjukkan kepada pelanggan cara menggunakan fungsi yang lebih canggih tanpa terlebih dahulu menunjukkan kepada mereka dasar-dasar cara kerja produk Anda. Mulailah dengan hal-hal yang mudah terlebih dahulu dan kemudian, saat pengguna Anda membangun pengetahuan mereka, tunjukkan kepada mereka fitur-fitur canggih.
Daftar Isi
Daftar isi memberi pelanggan Anda cara yang sederhana, efisien, dan akrab untuk menemukan solusi atas pertanyaan atau masalah mereka dengan cepat. Itu tepat di awal dokumen, jadi mereka tidak perlu menyaring halaman teks untuk menemukan apa yang mereka cari. Ini harus mencakup semua judul utama dan subpos seperti yang dijelaskan di atas.
Jadikan itu dapat dicari
Ada suatu masa ketika sebagian besar dokumentasi pengguna dicetak. Sekarang, di era di mana hampir semua orang memiliki akses ke smartphone, membuat dokumentasi elektronik menjadi lebih masuk akal. Itu tidak berarti Anda tidak dapat membuat versi cetak juga, tetapi versi elektronik menawarkan sejumlah keuntungan yang akan kita bahas lebih detail di bawah ini.
Seperti daftar isi, konten yang dapat ditelusuri memberi pengguna akses yang lebih mudah ke konten Anda dan membantu mereka menemukan solusi sendiri.
Aksesibilitas
Buat konten yang dapat diakses. Ini berarti memastikan bahwa dokumentasi elektronik mematuhi standar aksesibilitas bagi orang-orang yang mungkin buta atau tunanetra, tuli atau sulit mendengar, atau mungkin memiliki cacat kognitif.
Ingat, banyak pelanggan Anda memerlukan ini untuk memahami dan mengakses dokumentasi pengguna Anda sepenuhnya. Jangan tinggalkan mereka!
Cari tahu lebih banyak tentang dokumen dan aksesibilitas web
Dapatkan sumber daya untuk memastikan konten yang dapat diakses
Desain yang bagus
Berikan pengguna Anda dokumen yang ingin mereka lihat dan mereka akan cenderung menggunakannya.
Rancang bahan dengan mempertimbangkan pelanggan Anda. Jadikan itu berguna dan ramah. Hindari paragraf panjang teks atau halaman yang dikemas terlalu penuh dengan konten. Berikan ruang kosong untuk membantu memecah kemonotonan dan membuat prospek mempelajari produk baru tidak terlalu menakutkan.
Sertakan grafik dan gambar sebanyak mungkin untuk ditampilkan daripada memberi tahu pelanggan Anda cara menggunakan produk Anda. Untuk dokumentasi elektronik, gunakan video dan GIF.
Gunakan font yang konsisten dan warna pelengkap di beberapa dokumen. Jika organisasi Anda memiliki panduan gaya (yang SANGAT saya sarankan untuk dibuat jika belum ada), pastikan dokumentasi Anda mematuhinya.
Template Snagit membuatnya sangat mudah untuk membuat dokumentasi pengguna yang tampak profesional dari serangkaian tangkapan layar atau gambar lainnya. Cukup kumpulkan gambar yang Anda butuhkan, pilih Buat lalu Gambar dari Template, dan Anda siap melakukannya.
Snagit hadir dengan sekumpulan template gratis yang dirancang secara profesional, dan dengan TechSmith Assets for Snagit, Anda mendapatkan akses ke lebih banyak lagi!
Umpan balik dari pengguna nyata dan/atau penguji beta
Anda tidak dapat membuat dokumentasi pengguna yang benar-benar hebat sampai Anda mendengarkan orang-orang di luar organisasi Anda yang benar-benar menggunakan produk tersebut.
Pelajari poin rasa sakit mereka dan cobalah untuk mengatasinya sebaik mungkin. Cari tahu apa yang mereka katakan perlu Anda ketahui untuk menggunakan produk Anda dengan sebaik-baiknya. Sementara beberapa di antaranya mungkin tampak jelas, saya jamin Anda akan mempelajari hal-hal yang bahkan tidak pernah Anda pertimbangkan.
Tautan ke dokumentasi lain
Pastikan pelanggan Anda memiliki akses ke lebih banyak sumber daya organisasi Anda tentang cara menjadi sukses dengan produk Anda. Untuk dokumentasi pengguna elektronik, ini bisa sesederhana menyediakan tautan ke tutorial, FAQ, forum pengguna, dan banyak lagi.
Tetapi bahkan dokumentasi cetak dapat mencakup hal-hal seperti alamat situs web dan nomor telepon untuk dukungan lebih lanjut.
Bonus! Tambahkan petunjuk langkah demi langkah
Panduan langkah demi langkah membantu menghindari blok teks yang panjang dan memberikan cara yang lebih jelas untuk menunjukkan suatu proses daripada mencoba menjelaskannya melalui teks saja. Mereka lebih mudah diikuti, lebih mudah dipahami, dan menawarkan pengalaman yang jauh lebih ramah pengguna daripada sekadar memberi tahu seseorang cara menyelesaikan tugas.
Dan ingat, menyertakan konten visual dalam petunjuk langkah demi langkah Anda akan membuatnya lebih baik.
Snagit menyediakan Alat Langkah yang mudah digunakan yang membantu Anda membuat dokumentasi langkah demi langkah yang hebat. Plus, Alat Kombinasikan Gambar memungkinkan Anda untuk menggabungkan tangkapan layar individual dan gambar lain menjadi satu gambar untuk mengedit dan menandai dengan lebih mudah.
Cara membuat dokumentasi pengguna yang hebat
Langkah 1: Rencanakan
Setiap kumpulan dokumen pengguna yang hebat dimulai dengan sebuah rencana. Berikut adalah beberapa tips tentang cara untuk mendapatkan di mana Anda ingin pergi.
Tahu harus mulai dari mana
Banyak orang berasumsi bahwa jika Anda tahu produk Anda, Anda bisa mulai membuat dokumentasi Anda. Tapi ada lebih banyak yang masuk ke dalamnya. Sebaliknya, mulailah dengan rencana untuk memastikan bahwa Anda benar-benar membantu pengguna Anda.
Sebelum Anda membuat dokumentasi, berikut beberapa hal yang perlu diperhatikan:
- Apa yang harus Anda sertakan? Apa yang harus Anda tinggalkan? (Petunjuk: Di sinilah umpan balik pengguna dapat SANGAT membantu!)
- Dalam urutan apa kita harus menyajikan informasi? (Ingat garis besar esai dari sekolah? Gunakan itu!)
- Sumber daya apa lagi yang akan tersedia? Bagaimana kami akan memberikan akses/tautan ke sana?
- Siapa yang bertanggung jawab untuk membuat dokumen? Siapa yang bertanggung jawab atas umpan balik pada dokumen? Siapa yang memiliki persetujuan akhir?
- Apakah ini perlu diterjemahkan atau dilokalkan?
Jawaban atas pertanyaan tersebut membentuk cara Anda membuat dokumentasi. Perencanaan memastikan proses yang lancar dan dokumen pengguna yang lebih baik.
Kenali produk Anda
Pastikan Anda mengetahui produk Anda.
Itu tidak berarti Anda harus menjadi ahli mutlak dalam segala hal, tetapi siapa pun yang membuat panduan pengguna atau panduan pengguna harus memiliki pengalaman langsung dengan produk.
Andalkan pakar materi pelajaran Anda untuk pengetahuan yang lebih mendalam, tetapi Anda harus tahu cara menggunakannya sendiri sebelum mencoba mengajar orang lain.
Pilih format Anda
Selain itu, format akhir dokumen sama pentingnya. Apakah hanya akan dicetak? Apakah akan elektronik? Jika demikian, di mana ia akan tinggal?
Belum lama berselang, hampir semua dokumentasi pengguna hanya dicetak. Namun, kecuali Anda memiliki alasan yang sangat bagus, saya sarankan setidaknya memiliki versi elektronik yang tersedia di situs web Anda.
Sebagian besar pengguna memiliki akses 24 jam ke ponsel cerdas, komputer, atau tablet, dan mereka terbiasa menemukan apa pun yang ingin mereka ketahui kapan pun mereka ingin mengetahuinya. Menempatkan sumber daya pengguna secara online memberi mereka akses di mana pun mereka berada, artinya mereka tidak perlu mencari melalui laci atau lemari arsip untuk menemukan manual pengguna yang belum pernah mereka lihat selama bertahun-tahun.
Selain itu, membuat dokumentasi elektronik lebih mudah diakses oleh penyandang disabilitas. Versi cetak saja akan bekerja untuk kebanyakan orang, tetapi apakah Anda siap untuk membuat versi braille untuk pengguna yang mungkin tunanetra atau tunanetra? Bagaimana dengan pengguna yang memiliki disabilitas fisik di mana sulit bagi mereka untuk memanipulasi objek dengan tangan mereka?
Ada alat untuk membuat dokumentasi elektronik lebih mudah diakses semua orang, tetapi versi cetak saja memberikan masalah aksesibilitas yang jauh lebih sulit.
Plus, dokumentasi elektronik jauh lebih mudah untuk diperbarui, karena tinggal di web.
Haruskah saya membuat dokumentasi saya menjadi PDF?
Kecuali jika Anda ingin orang mencetak dokumentasi Anda, JANGAN membuatnya menjadi PDF. Alih-alih, buat versi elektronik tersedia di situs web Anda sebagai teks situs web biasa. Ada beberapa alasan untuk itu, tetapi semuanya bermuara pada ini: Ini lebih mudah digunakan.
Jika Anda ingin menawarkan versi PDF yang dapat diunduh dari dokumentasi Anda, tidak apa-apa. Namun pastikan juga tersedia di situs web Anda dalam format non-PDF.
Langkah 2: Buat dokumen pengguna Anda
Setelah Anda menjawab semua pertanyaan dan membuat semua keputusan yang diuraikan di atas, saatnya membuat dokumentasi pengguna Anda. Saya tidak akan bermaksud memberi tahu Anda cara PERSIS membuat dokumentasi untuk produk spesifik Anda, tetapi ada beberapa hal penting yang perlu diingat.
- Hindari jargon dan istilah yang sangat teknis kecuali jika benar-benar diperlukan (dan kemudian pastikan untuk mendefinisikannya).
- Hindari akronim kecuali Anda menjelaskan artinya.
- Gunakan gaya penulisan yang umum dikenal, seperti AP atau Chicago, bila memungkinkan. Jika organisasi Anda memiliki panduan gaya perusahaan, gunakan itu.
- Jangan berasumsi bahwa pengguna tahu apa pun tentang produk Anda atau apa fungsinya. TUNJUKKAN kepada mereka apa yang perlu mereka ketahui untuk menjadi sukses.
- Ingatlah untuk menggunakan bahasa yang sederhana. Menulis untuk tingkat kelas delapan atau lebih rendah. Bahkan untuk pembaca tingkat lanjut, bahasa sederhana menghasilkan pemrosesan yang lebih cepat dan pemahaman yang lebih baik.
- Desainnya harus menyenangkan, tidak mengintimidasi, dan menarik pengguna. Buat mereka INGIN menggunakan dokumentasi Anda.
Langkah 3: Ujilah
Panduan pengguna hanya bagus jika membantu pelanggan Anda menggunakan produk Anda sebaik mungkin. Dan Anda tidak dapat mengetahuinya sampai seseorang menggunakannya. Sebelum kreasi baru Anda tersebar ke seluruh dunia, Anda ingin mengujinya. Berikut adalah beberapa tips!
- Praktik terbaik: Berikan kepada sekelompok pengguna nyata atau penguji beta dan lihat bagaimana mereka melakukannya. Masukkan umpan balik mereka ke dalam dokumen yang sudah jadi.
- Jika Anda tidak memiliki umpan balik pengguna pengujian beta, ujilah secara internal, sebaiknya dengan karyawan yang paling tidak mengenal produk tersebut.
- Dapatkan umpan balik dari pengembang dan insinyur. Mereka tahu produk lebih baik daripada siapa pun, dan mereka dapat menunjukkan hal-hal yang mungkin Anda lewatkan.
Langkah 4: Perbarui dokumentasi Anda
Saat produk Anda berubah, Anda harus terus memperbarui dokumentasi pengguna. Seperti disebutkan di atas, ini memberikan dokumentasi elektronik keuntungan besar dibandingkan cetak. Namun, bahkan dokumen cetak saja dapat diperbarui dan tersedia untuk diunduh di situs web Anda.
Ingat, konten Anda hanya bagus jika akurat. Pastikan bahwa apa yang Anda berikan kepada pelanggan benar-benar membantu mereka menggunakan produk Anda.
Ringkasan
Jika Anda tidak mengingat hal lain, ingatlah bahwa dokumentasi pengguna yang baik harus dibuat, dirancang, dan disajikan dengan cara yang paling membantu pengguna Anda .
Beri mereka dokumentasi yang terus menyenangkan mereka dan berikan jenis pengalaman pelanggan yang Anda inginkan.
Jadikan dokumentasi Anda mudah diakses, berguna, dan visual.
Mudah membuat panduan pengguna (Templat Gratis)
Template Snagit adalah cara tercepat untuk membuat panduan pengguna. Buat panduan langkah demi langkah dengan tampilan sederhana dan profesional.
Unduh
Pertanyaan yang sering diajukan
Dokumentasi pengguna (juga disebut manual pengguna akhir, panduan pengguna akhir, manual instruksi, dll.) adalah konten yang Anda berikan kepada pengguna akhir untuk membantu mereka menjadi lebih sukses dengan produk atau layanan Anda.
Apa saja jenis dokumentasi pengguna?
Di masa lalu, dokumentasi pengguna diberikan melalui file bantuan yang bersifat lokal untuk mesin pengguna atau manual fisik atau buklet. Saat ini, dokumentasi pengguna hampir selalu ditawarkan secara online, yang telah membantu penulis teknis menjadi lebih imajinatif dalam membantu pengguna.
Apa yang termasuk dalam dokumentasi pengguna?
Dokumentasi pengguna yang bagus harus mencakup: Bahasa sederhana, kesederhanaan, visual, fokus pada masalah, hierarki dan alur logis, daftar isi, konten yang dapat dicari, konten yang dapat diakses, desain yang baik, umpan balik dari pengguna nyata, dan tautan ke sumber daya lebih lanjut.
Bagaimana Anda membuat dokumen pengguna?
Dokumentasi pengguna yang hebat dapat dibuat dalam empat langkah sederhana: Pertama Ketahui tujuan Anda dan buat rencana untuk mencapainya. Selanjutnya, buat
panduan Anda berdasarkan rencana Anda. Kemudian uji panduan Anda untuk memastikannya berfungsi sebelum Anda membebaskannya. Akhirnya, tetap up to date. Saat produk Anda berubah, perbarui dokumentasi Anda untuk mencerminkan perubahan tersebut.