Cara Menulis Manual Prosedur

Isi kandungan:

Anonim

Prosedur seperti resipi-satu set arahan yang menyatakan dengan jelas siapa yang melakukan sesuatu, apabila perlu dilakukan, bagaimana ia dilakukan dan apakah hasilnya. Senaraikan setiap langkah dalam susunan itu mesti diselesaikan. Menyusun berbilang prosedur dalam manual yang dianjurkan oleh deskripsi, jabatan, fungsi, atau mana-mana perintah kerja yang membuat maklumat paling mudah diakses oleh pengguna manual. Jangan mengelirukan dasar dengan prosedur. Dasar adalah peraturan atau pernyataan kedudukan; Prosedur adalah apa yang dilakukan oleh orang untuk menjalankan dasar.

Perkara yang anda perlukan

  • Dokumentasi sedia ada yang mungkin bahan sumber

  • Pakar pelajaran yang tahu cara melaksanakan prosedur

Memutuskan prosedur yang hendak didokumenkan. Dua kaedah untuk memilih kandungan manual anda adalah untuk meninjau pengguna manual yang berpotensi untuk mengetahui tugas yang mereka perlukan dijelaskan atau maklumat lanjut, atau anda mungkin memilih untuk membuat senarai masalah operasi yang boleh anda selesaikan dengan tatacara yang jelas.

Kumpulkan maklumat. Seseorang yang sudah melakukan tugas itu adalah sumber terbaik anda kecuali anda membuat prosedur dari awal. Tonton orang melaksanakan tugas dan ambil nota, atau minta orang itu menulis untuk anda semua langkah yang terlibat dalam tugas itu, serta sebarang petua atau amaran yang dipelajari melalui pengalaman.

Tetapkan susunan manual anda. Format dua lajur membuat prosedur jelas dan mudah dibaca. Tajuk setiap halaman dengan nama prosedur, dan masukkan di bawah tajuk senarai atau perenggan apa-apa fakta yang tidak termasuk dalam langkah, seperti berapa kerap prosedur dilakukan dan petua atau amaran. Prosedur ini harus mengikuti selepas itu dalam jadual dua lajur.

Tulis draf kasar. Di lajur kiri, senaraikan orang yang bertanggungjawab untuk prosedur tersebut. Di lajur kanan, senaraikan langkah-langkah yang dilakukan oleh orang itu. Sekiranya prosedur melibatkan beberapa orang, mereka semua harus dapat melihat dengan jelas di mana mereka sesuai dengan proses dan apa yang perlu dilakukan.

Uji prosedur. Dapatkan seseorang yang tidak dikenali dengan prosedur untuk mengikuti mereka dari draf. Adalah penting untuk menggunakan seseorang yang tidak berpengalaman, jadi orang itu tidak akan mengambil jalan pintas biasa atau gloss atas mata yang tidak jelas pembaca lain tidak akan faham.

Semak draf. Memperjelas, menambah, memadam dan menyusun semula langkah-langkah sehingga prosedur dapat diikuti oleh sesiapa yang membaca manual.

Terbitkan manual. Sertakan jadual kandungan supaya pembaca dapat dengan mudah mencari prosedur. Tambah glosari menentukan sebarang istilah yang tidak biasa atau khusus untuk industri anda.

Petua

  • Jangan gunakan variasi perkataan yang elegan untuk menghidupkan tulisan. A "widget" adalah widget setiap kali, bukan "item" atau "peranti". Menggambarkan perkara secara konsisten mungkin berulang, tetapi ia meningkatkan kejelasan untuk pembaca.