Tidak kira seberapa bijak seorang penemu, pengaturcara atau rasionalisator, kadang-kadang ciptaannya tidak dapat digunakan untuk tujuan yang dimaksudkan. Sebabnya adalah manual arahan yang tidak betul yang dibuat atau tidak lengkap. Tetapi penemu yang bijak kadang-kadang menulis arahan sedemikian sehingga, selain daripada pakar yang sempit, tidak ada yang dapat membaca makalah ini. Oleh itu, bagaimana anda membuat dokumen yang diperlukan dengan betul?
Ia perlu
- - pengetahuan seratus peratus mengenai produk atau produk perisian yang manualnya ditulis;
- - pengetahuan dalam bidang linguistik;
- - kemahiran Menulis.
Arahan
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 manual pengguna, anda perlu mengetahui sistem yang dijelaskan seratus peratus, tetapi melihatnya melalui mata pelajar yang jahil. Andaikan manual pengguna ditulis untuk utiliti perisian yang belum mempunyai analog. Bayangkan ini adalah kali pertama anda menggunakan program ini. Di mana anda bermula? Apakah perkara pertama yang perlu diketahui? Susun pengetahuan ini ke dalam kategori kepentingan.
Langkah 2
Dengan membahagikan semua maklumat mengenai penciptaan anda kepada beberapa kumpulan, anda telah membuat rancangan untuk menulis manual pengguna. Mula menerangkan karya dalam program anda dari awal, tinggalkan butiran yang paling sukar, seperti memprogramkan semula ciri atau menangani kesalahan kritikal. Pada peringkat ini, anda harus menyediakan kandungan manual pengguna - salah satu bahagian yang diperlukan dalam dokumen ini.
Langkah 3
Sekiranya manual yang anda buat dimaksudkan untuk digunakan di sebuah syarikat besar, maka anda harus memperhatikan standard korporat yang digunakan di sana. Sebagai contoh, di banyak syarikat Rusia, manual pengguna tidak diterima tanpa sokongan ilustrasi, dengan kata lain, gambar yang menjelaskan apa yang ditulis. Sebagai tambahan kepada isi, manual pengguna harus mengandungi bahagian wajib lainnya: - Anotasi, yaitu penjelasan mengenai objektif umum manual dan produk yang dijelaskan; - pengenalan, yang menjelaskan dokumen yang berkaitan dengan manual pengguna dan bagaimana untuk menggunakan manual; - bahagian yang menerangkan penggunaan produk pada pelbagai tahap penggunaannya, misalnya, langkah pertama, pembaikan atau penyelenggaraan; - bahagian soalan dan jawapan yang sering diajukan kepada mereka; - glosari atau indeks subjek.
Langkah 4
Biasanya, seorang penulis teknikal terlibat dalam pembuatan manual pengguna - orang yang mempunyai semua pengetahuan yang diperlukan baik dalam bahasa dan produk yang dijelaskan. Sebagai penulis teknikal tanpa latihan, ada beberapa peraturan yang perlu diingat. Pertama, anda tidak boleh menyalahgunakan istilah khas yang tidak difahami oleh pengguna biasa. Kedua, setiap istilah yang digunakan mesti diperincikan dan dijelaskan. Ketiga, anda perlu menulis dengan seberapa jelas dan ringkas. Akhirnya, seorang penulis teknikal mesti dapat melihat teks mereka sendiri melalui pandangan pengguna biasa untuk melihat kekurangan teks mereka sendiri.
Langkah 5
Adalah baik untuk menguji teks siap manual pengguna dalam praktiknya dengan memberikannya kepada orang yang tidak ada kaitan dengan produk yang dijelaskan. Dengan usaha bersama, adalah mungkin untuk menghilangkan semua kekurangan dan kekurangan dari dokumen tersebut.
