Tidak peduli seberapa cerdik seorang penemu, pemrogram, atau rasionalis, terkadang ciptaannya tidak dapat digunakan untuk tujuan yang dimaksudkan. Alasan untuk ini adalah manual instruksi yang dibuat secara tidak benar atau tidak ada sama sekali. Tetapi bahkan penemu yang cerdik terkadang menulis instruksi sedemikian rupa sehingga, selain dari spesialis yang sempit, tidak ada yang bisa membaca makalah ini. Jadi, bagaimana Anda menyusun dokumen yang diperlukan dengan benar?
Itu perlu
- - seratus persen pengetahuan tentang perangkat atau produk perangkat lunak yang manual ini sedang ditulis;
- - pengetahuan di bidang linguistik;
- - kemampuan menulis.
instruksi
Langkah 1
Manual pengguna atau, dengan kata lain, manual operasi adalah dokumen yang dirancang untuk memberikan bantuan dalam menggunakan sistem tertentu kepada penggunanya. Untuk menyusun panduan pengguna, Anda perlu mengetahui sistem yang dijelaskan seratus persen, tetapi lihatlah melalui mata siswa yang bodoh. Misalkan panduan pengguna ditulis untuk utilitas perangkat lunak yang belum memiliki analog. Bayangkan ini adalah pertama kalinya Anda menggunakan program ini. Di mana Anda mulai? Apa hal pertama yang harus diketahui? Atur pengetahuan ini ke dalam kategori penting.
Langkah 2
Dengan membagi semua informasi mengenai kreasi Anda ke dalam kelompok, Anda telah menyusun rencana untuk menulis panduan pengguna. Mulailah menjelaskan pekerjaan dalam program Anda dari awal, tinggalkan detail yang paling sulit, seperti memprogram ulang fitur atau menangani kesalahan kritis. Pada tahap ini, Anda harus menyiapkan konten panduan pengguna - salah satu bagian yang diperlukan dari dokumen ini.
Langkah 3
Jika manual yang Anda buat dimaksudkan untuk digunakan di perusahaan besar, maka Anda harus memperhatikan standar perusahaan yang diadopsi di sana. Misalnya, di banyak perusahaan Rusia, manual pengguna tidak diterima tanpa dukungan ilustrasi, dengan kata lain, gambar yang menjelaskan apa yang tertulis. Selain konten, panduan pengguna harus berisi bagian wajib lainnya: - Anotasi, yaitu penjelasan tentang tujuan umum manual dan produk yang dijelaskan; - pendahuluan, yang menjelaskan dokumen yang terkait dengan panduan pengguna dan bagaimana untuk menggunakan manual; - bagian yang menjelaskan penggunaan produk pada berbagai tahap penggunaannya, misalnya, langkah pertama, perbaikan atau pemeliharaan; - bagian pertanyaan dan jawaban yang sering diajukan; - glosarium atau indeks subjek.
Langkah 4
Biasanya, seorang penulis teknis terlibat dalam pembuatan panduan pengguna - seseorang yang memiliki semua pengetahuan yang diperlukan baik dalam bahasa maupun produk yang dijelaskan. Sebagai penulis teknis tanpa pelatihan, ada beberapa aturan yang perlu diingat. Pertama, Anda tidak boleh menyalahgunakan istilah khusus yang tidak dapat dimengerti oleh pengguna biasa. Kedua, setiap istilah yang digunakan harus dirinci dan dijelaskan. Ketiga, Anda harus menulis sejelas dan sesingkat mungkin. Akhirnya, seorang penulis teknis harus dapat melihat teks mereka sendiri melalui mata pengguna biasa untuk melihat kekurangan dari teks mereka sendiri.
Langkah 5
Adalah baik untuk menguji teks akhir panduan pengguna dalam praktik dengan menawarkannya kepada orang yang tidak ada hubungannya dengan produk yang dijelaskan. Dengan upaya bersama, adalah mungkin untuk menghilangkan semua kekurangan dan perangkap dokumen.
