Selalunya diisi dengan jargon, akronim, dan arahan yang memerlukan Ph.D untuk memahami, manual pengguna perisian kadang-kadang ditulis dari sudut pandangan pemaju dan bukannya pengguna. Akibatnya, panduan boleh membuat andaian mengenai tahap kemahiran pembaca yang sering tidak betul. Langkah pertama dalam menulis manual pengguna yang baik adalah untuk mendapatkan proses penulisan sebenar jauh dari jurutera yang mungkin.
Pembangun perisian mengetahui lebih daripada sesiapa yang membuat perisian berfungsi, tetapi itu tidak bermakna pemaju harus menulis panduan itu. Sebaliknya, ia adalah kelemahan yang berbeza. Lebih penting daripada pemahaman yang mendalam tentang kerja dalaman perisian adalah pemahaman tentang siapa pengguna akhir, tahap pendidikannya, dan bagaimana pengguna akhir akan menggunakan perisian tersebut. Dalam kebanyakan kes, pengguna akhir tidak perlu mengetahui perkara-perkara yang lebih baik dari pengaturcaraan dan kerja-kerja back-end perisian - mereka hanya perlu tahu cara menggunakannya untuk menjadikan pekerjaan mereka lebih mudah.
Ujian Pengguna
Manual pengguna sepatutnya berorientasikan tugas, bukannya deskriptif. Kerana manual ditulis untuk membantu pengguna memahami bagaimana melaksanakan tugas-tugas tertentu, penulis perlu mempunyai pemahaman tentang tugas-tugas tersebut juga, dan sebagai akibatnya, melalui setiap langkah diskret setiap ciri adalah sangat penting. Ia tidak perlu bagi penulis untuk semestinya mengetahui bagaimana program itu dibuat dari sudut reka bentuk atau pembangunan, tetapi penting untuk mempunyai pengetahuan kerja yang kuat terhadap semua ciri-cirinya. Semasa melaksanakan setiap tugas, luangkan masa untuk menulis setiap langkah, termasuk klik, menu drop-down, dan tindakan lain.
Proses Temu Wawancara
Walaupun pemaju bukanlah orang yang menulis manual, dia masih menjadi sumber yang berharga kepada penulis, dan sebelum menulis bermula, merancang pertemuan kickoff antara penulis, pemaju dan jurutera, dan pengguna akhir yang berpotensi untuk membantu memaklumkan kerja penulis dari awal. Temu bual dengan pakar dan jurutera perkara harus direkodkan, dengan transkrip dibuat untuk rujukan kemudian.
Imejan
Panduan pengguna tidak boleh terlalu teks. Sebaliknya, gunakan penggunaan grafik dan klip skrin liberal. Perihalan tindakan lebih jelas dengan arahan berasaskan teks yang disertakan dengan klip skrin yang jelas menggambarkan arah itu. Termasuk kedua-dua sebelum dan selepas pandangan, untuk menunjukkan apa yang skrin kelihatan seperti sebelum mengambil setiap tindakan, dan apa yang berlaku selepas tindakan telah diambil. Utiliti tangkapan skrin mudah seperti Alat Perkakas termasuk dalam Microsoft Windows berfungsi dengan baik untuk menangkap imej-imej ini. Pastikan nombor setiap imej, dan masukkan kapsyen yang menggambarkannya dengan ringkas. Pusatkannya di bawah perenggan yang pertama kali memperkenalkan konsep yang digambarkan dalam imej.
Pemformatan
Berkomunikasi dengan jelas dalam dokumen teknikal memerlukan perancangan dan pematuhan yang mematuhi piawaian di seluruh panduan. Piawaian dalam persembahan, bahasa dan tatanama membantu mengelakkan kekeliruan. Templat tersedia dan boleh menjadi titik permulaan yang baik untuk keseragaman, walaupun ini pastinya boleh disesuaikan untuk memenuhi setiap keadaan. Menggunakan margin satu inci dengan lajur tunggal sesuai dengan keperluan untuk menambah grafik; tetapan dua lajur mungkin kelihatan terlalu sesak, dan boleh membuat penempatan gambar yang mengelirukan.
Versi dan Penjejakan
Lebih daripada apa-apa jenis dokumen lain, panduan pengguna perisian mungkin melalui pelbagai lelaran sebelum ia selesai, dan ia mungkin melalui proses kajian oleh pelbagai pemegang kepentingan. Menggunakan ciri Perubahan Trek di Microsoft Word adalah cara mudah untuk menjejaki komen dan perubahan setiap individu. Mewujudkan berbilang versi selepas setiap kitaran semakan, masing-masing dengan nama fail berbeza, turut membantu proses bersama dan memastikan semua pihak berkepentingan berpuas hati dengan hasil akhir.
