Sering diisi dengan jargon, akronim, dan arahan yang memerlukan gelar Ph untuk memahami, manual pengguna perangkat lunak kadang-kadang ditulis dari sudut pandang pengembang daripada pengguna. Akibatnya, panduan ini dapat membuat asumsi tentang tingkat keterampilan pembaca yang sering salah. Langkah pertama dalam menulis manual pengguna yang baik adalah untuk mendapatkan proses penulisan yang sebenarnya sejauh mungkin dari para insinyur.
Pengembang perangkat lunak mengetahui lebih dari siapa pun apa yang membuat perangkat lunak berfungsi, tetapi itu tidak berarti pengembang harus menulis panduan. Sebaliknya, itu adalah kerugian tersendiri. Lebih penting daripada pemahaman mendalam tentang cara kerja perangkat lunak dalam adalah pemahaman tentang siapa pengguna akhir akan, apa tingkat pendidikannya, dan bagaimana pengguna akhir akan menggunakan perangkat lunak. Dalam kebanyakan kasus, pengguna akhir tidak perlu mengetahui poin pemrograman yang lebih baik dan cara kerja back-end dari perangkat lunak - mereka hanya perlu tahu cara menggunakannya untuk membuat pekerjaan mereka lebih mudah.
Pengujian Pengguna
Manual pengguna harus sebagian besar berorientasi pada tugas, daripada sangat deskriptif. Karena manual ditulis untuk membantu pengguna memahami bagaimana menjalankan tugas tertentu, penulis perlu memiliki pemahaman tentang tugas-tugas itu juga, dan sebagai hasilnya, melalui setiap langkah terpisah dari setiap fitur sangat penting. Tidak perlu bagi penulis untuk selalu tahu bagaimana program itu dibuat dari sudut pandang desain atau pengembangan, tetapi penting untuk memiliki pengetahuan kerja yang kuat dari semua fitur-fiturnya. Saat menjalankan setiap tugas, luangkan waktu untuk menuliskan setiap langkah, termasuk klik, menu drop-down, dan tindakan lainnya.
Proses Wawancara
Meskipun pengembang tidak boleh menjadi orang yang menulis manual, ia masih akan menjadi sumber daya berharga bagi penulis, dan sebelum menulis dimulai, rencanakan pertemuan kickoff antara penulis, pengembang dan insinyur, dan pengguna akhir potensial untuk membantu menginformasikan karya penulis dari awal. Wawancara dengan para ahli dan insinyur bidang studi harus dicatat, dengan transkrip dibuat untuk referensi di kemudian hari.
Citra
Manual pengguna tidak boleh terlalu berat teks. Melainkan, gabungkan penggunaan grafis dan klip layar secara bebas. Deskripsi suatu tindakan jauh lebih jelas dengan arah berbasis teks disertai dengan klip layar yang dengan jelas menggambarkan arah itu. Sertakan tampilan sebelum dan sesudah, untuk menunjukkan seperti apa tampilan layar sebelum mengambil setiap tindakan, dan apa yang terjadi setelah tindakan dilakukan. Utilitas tangkapan layar sederhana seperti Snipping Tool yang disertakan dalam Microsoft Windows berfungsi dengan baik untuk mengambil gambar ini. Pastikan untuk memberi nomor pada setiap gambar, dan sertakan keterangan yang menjelaskannya secara singkat. Pusatkan tepat di bawah paragraf yang pertama kali memperkenalkan konsep yang digambarkan dalam gambar.
Memformat
Berkomunikasi dengan jelas dalam dokumen teknis membutuhkan perencanaan dan ketaatan terhadap standar di seluruh panduan ini. Standar dalam presentasi, bahasa, dan nomenklatur membantu menghindari kebingungan. Template tersedia dan bisa menjadi titik awal yang baik untuk keseragaman, meskipun ini tentu bisa disesuaikan agar sesuai dengan setiap situasi. Menggunakan margin satu inci dengan satu kolom paling sesuai dengan kebutuhan untuk menambahkan grafik; pengaturan dua kolom mungkin tampak terlalu ramai, dan dapat membuat penempatan gambar membingungkan.
Versi dan Pelacakan
Lebih dari jenis dokumen lainnya, panduan pengguna perangkat lunak kemungkinan akan melewati beberapa iterasi sebelum selesai, dan kemungkinan akan melalui proses peninjauan oleh berbagai pemangku kepentingan. Menggunakan fitur Track Changes di Microsoft Word adalah cara mudah untuk melacak komentar dan perubahan masing-masing individu. Membuat banyak versi setelah setiap siklus peninjauan, masing-masing dengan nama file yang berbeda, juga membantu proses bersama dan memastikan semua pemangku kepentingan puas dengan hasil akhir.
