9 Tips untuk Dokumentasi Pengguna yang Luar Biasa (dengan Contoh)

Dokumentasi pengguna adalah bagian penting dari keseluruhan produk yang dikirimkan ke pelanggan Anda. Ini membantu pengguna akhir menjadi lebih sukses dengan produk atau layanan Anda.

Di masa lalu, dokumentasi pengguna diberikan melalui file bantuan yang bersifat lokal untuk mesin pengguna atau manual fisik atau buklet. Ini berarti itu tidak dapat diperbarui atau diubah dengan mudah dan penyedia perangkat lunak mendapat sangat sedikit data tentang bagaimana konten mereka digunakan.

Saat ini, dokumentasi pengguna hampir selalu ditawarkan secara online, yang telah membantu penulis teknis menjadi lebih imajinatif dalam membantu pengguna. Mereka dapat mengumpulkan data, mencoba berbagai teknik pembelajaran, mengulangi lebih cepat, dan menghasilkan pengalaman konten yang lebih kaya bagi pengguna.

Di situlah posting blog ini masuk! Saya

dalam posting ini, kami akan mengeksplorasi apa yang dapat Anda lakukan untuk meningkatkan dokumentasi pengguna Anda dan meninjau beberapa contoh konten dukungan pengguna yang sangat baik.

Mulailah dengan sebuah rencana

Seperti kebanyakan hal dalam hidup, yang terbaik adalah memulai dengan rencana, dan membuat dokumentasi pengguna tidak berbeda. Itulah mengapa Anda ingin memastikan bahwa Anda bertanya pada diri sendiri (dan mungkin mereka yang meminta dokumentasi) banyak pertanyaan sebelum memulai.

1. Pertimbangkan audiens Anda

Untuk siapa kamu membuat ini? Pengguna akhir? Seorang administrator sistem? Apakah konten ini hanya akan ditinjau secara internal atau akan dilihat secara eksternal juga? Untuk siapa Anda membuat dokumentasi pengguna membantu membingkai informasi yang Anda bagikan.

2. Evaluasi dan ingat tujuan akhir Anda

Tujuan utama dari dokumentasi apa pun adalah untuk mengajarkan sesuatu kepada audiens Anda. Setelah menentukan siapa yang akan menggunakan dokumentasi Anda, Anda harus memutuskan apa yang Anda inginkan dari mereka.

Tindakan apa yang Anda ingin agar dapat dilakukan audiens setelah meninjau dokumentasi? Dengan mengingat jawaban atas pertanyaan itu, Anda akan dapat memberikan jumlah konten yang tepat untuk tugas yang dimaksud.

3. Pastikan dokumentasi pengguna Anda mudah ditemukan

Dokumentasi pengguna yang tersembunyi hampir sama tidak bergunanya dengan dokumentasi pengguna yang buruk. Penting untuk memastikan bahwa dokumentasi pengguna yang Anda buat mudah ditemukan oleh mereka yang membutuhkannya.

Itu tidak hanya berarti memastikan itu terlihat, itu juga berarti bahwa pengguna dapat menavigasi dalam dokumentasi teknis Anda dan dengan cepat menemukan jawaban atas pertanyaan mereka.

Semakin cepat audiens Anda dapat menemukan jawaban itu, semakin bahagia mereka. Ini juga akan menghemat waktu Anda karena harus menjawab pertanyaan penting tetapi umum tentang produk Anda.

Tulisan ringkas dan kuat

Tulisan yang kuat sangat penting untuk dokumentasi pengguna yang hebat. Tapi menulis mempengaruhi lebih dari bagaimana dokumentasi pengguna membaca atau suara. Ini juga dapat memengaruhi betapa mudahnya menavigasi dokumentasi pengguna Anda.

4. Tulis judul dan subjudul yang deskriptif

Pastikan judul Anda berguna dan, yang paling penting, spesifik. Menulis judul atau subjudul yang diformulasikan untuk menjawab pertanyaan seringkali merupakan yang terbaik. Membingkai judul dengan cara ini memudahkan pengguna akhir Anda menemukan apa yang mereka cari dan juga membantu Anda menulis artikel yang menjawab kebutuhan pengguna secara langsung.

Unbounce melakukan pekerjaan luar biasa dalam menulis judul dan subtitle yang efektif di seluruh dokumentasi pengguna mereka. Ini membuat dokumentasi mereka mudah dinavigasi. Setiap artikel tertentu memiliki daftar isi sendiri yang membuat menemukan jawaban atas pertanyaan tertentu menjadi mudah.

5. Permudah browsing

Memberikan informasi dengan cara yang mudah dipindai membantu pengguna menghemat waktu. Sebagai manusia, kami menghargai setiap penghematan waktu yang bisa kami dapatkan. Plus, pengguna mungkin tidak tahu persis apa yang mereka cari. Saat itulah konten yang mudah dijelajahi paling bermanfaat.

IBM melakukan pekerjaan yang baik untuk membuat konten bantuan mereka mudah dijelajahi dengan mengatur daftar isi yang bersih dan menyediakan topik terkait.

6. Buatlah mudah dicari

Google telah melatih kami bahwa menemukan jawaban atas pertanyaan kami semudah mengetiknya di kotak pencarian. Dokumentasi bantuan Anda harus mencerminkan harapan ini. Jika konten bantuan Anda tidak dapat ditelusuri, mungkin konten tersebut tidak terlalu membantu.

Basis pengetahuan Hubspot yang mendalam membuat layanan mandiri menjadi mudah bagi klien mereka.

Gunakan Visual untuk Meningkatkan Pemahaman

Dokumentasi pengguna yang baik sangat visual. Sementara tulisan dan teks yang kuat sangat penting untuk dokumentasi pengguna yang mengagumkan, orang-orang belajar paling baik ketika visual juga hadir.

7. Gunakan tangkapan layar beranotasi

Tangkapan layar beranotasi adalah visual yang kuat untuk digunakan dalam dokumentasi pengguna. Mereka menghapus dugaan untuk pengguna dengan menunjukkan dengan tepat langkah apa yang perlu mereka ambil.

Dengan program seperti TechSmith Snagit, mudah untuk menambahkan info teks, panah, dan lainnya ke tangkapan layar. Misalnya, Anda akan melihat saya menggunakan screenshot beranotasi yang saya buat dengan Snagit di seluruh posting blog ini.

Jika Anda merasa terinspirasi, Anda bahkan dapat mencoba Alat Langkah Snagit yang memungkinkan Anda mengidentifikasi bagian-bagian dari suatu gambar dengan menempatkan keterangan yang diurutkan saat Anda mengarahkan dan mengeklik. Setiap kali Anda mengklik untuk menambahkan langkah lain, nomor tersebut secara otomatis maju.

Perusahaan yang melakukan pekerjaan luar biasa dalam memanfaatkan kekuatan tangkapan layar dalam dokumentasi mereka adalah Asana. Sepanjang dokumentasi pengguna yang luar biasa, mereka menggunakan tangkapan layar beranotasi untuk memandu pelanggan dengan jelas.

8. Manfaatkan video untuk menunjukkan bukan memberi tahu

Video berfungsi dengan baik untuk mendemonstrasikan suatu proses. Banyak dokumentasi pengguna yang mengagumkan menggabungkan kekuatan video dengan instruksi teks. Misalnya, ini adalah praktik yang baik untuk menggunakan video pendek untuk menelusuri proses dengan cepat.

Kemudian, di samping video, Anda dapat memberikan panduan langkah demi langkah teks untuk referensi pengguna saat mereka mencoba prosesnya sendiri. Dengan begitu mereka tidak perlu menonton video berulang-ulang jika hanya butuh pengingat cepat.

Dalam tutorial produk TechSmith kami, kami menggunakan video utama untuk memberikan gambaran lengkap tentang fitur atau topik yang sedang kami diskusikan. Kemudian, di bawah video, kami menyediakan cuplikan yang disertai dengan tangkapan layar atau GIF animasi untuk menegaskan kembali poin utama video.

9. Tunjukkan contoh dan hasil akhirnya

Pengguna perlu tahu seperti apa berhasil menyelesaikan setiap tugas. Memberikan tangkapan layar contoh hasil akhir kepada pengguna adalah cara yang baik untuk menunjukkan hasil yang ideal kepada audiens Anda.

Dokumentasi pengguna yang hebat memudahkan pengguna akhir untuk menemukan jawaban atas pertanyaan mereka, yang menciptakan pengguna yang senang dan puas.

Bagian penting dalam membuat dokumentasi pengguna yang mengagumkan adalah menyediakan informasi yang jelas dan mudah dipindai. Visual seperti tangkapan layar, video, atau GIF animasi adalah cara yang bagus untuk berkomunikasi secara lebih efisien dan efektif dengan pengguna Anda.