Walaupun sering diabaikan oleh banyak pengguna komputer, fail bantuan memberikan maklumat penting tentang cara menggunakan aplikasi perisian yang berkaitan dengannya. Dengan mengklik "Bantuan", pengguna dapat memperoleh gambaran keseluruhan mengenai ciri program, deskripsi layar yang dilihatnya, petunjuk tentang cara menggunakan program untuk melakukan tugas tertentu atau membaca senarai pertanyaan yang sering diajukan mengenai program dan jawapan mereka. Menulis fail bantuan memerlukan kemampuan untuk bekerja dengan aplikasi perisian dan kemampuan untuk menjelaskan sesuatu dengan cara yang dapat difahami pengguna.
Langkah-langkah
Langkah 1. Dapatkan salinan perisian yang akan anda dokumentasikan
Sekiranya boleh, anda juga harus mendapatkan salinan spesifikasi bertulis untuk program ini, walaupun tidak semua pembangun perisian bekerja dengannya. Dalam beberapa kes, pengaturcara akan menyimpang dari spesifikasi, berdasarkan waktu pengembangan yang pendek atau tidak dapat membuat kod pada fitur tertentu.
Langkah 2. Dapatkan alat pengarang bantuan
Walaupun mungkin untuk membuat fail bantuan dengan tangan, menggunakan fail format teks kaya (.rtf), kebanyakan penulis fail bantuan menggunakan aplikasi perisian untuk menulis fail bantuan mereka, seperti RoboHelp, Help and Manual, Doc-To -Bantuan, MadCap Flare atau HelpLogix. Sebilangan besar alat pengarang bantuan merangkumi penyunting teks atau bekerja dengan program pemprosesan kata seperti Microsoft Word dan menyediakan antara muka pengguna yang membolehkan penulis bantuan melihat bagaimana fail bantuan akan kelihatan ketika dia menulisnya semasa menulis kod komputer di belakang tabir untuk membuat fail bantuan berfungsi. Beberapa alat pengarang bantuan juga menyertakan editor grafik untuk membuat tangkapan skrin untuk disertakan dalam fail bantuan.
Terdapat sejumlah format fail bantuan: Yang paling umum adalah Bantuan HTML, yang digunakan oleh aplikasi yang berjalan di Windows. (Format yang lebih lama, WinHelp, tidak lagi didukung.) Apple dan Unix masing-masing mempunyai format mereka sendiri, begitu juga Sun Microsystems, dengan JavaHelpnya. Aplikasi perisian yang dirancang untuk berjalan di bawah beberapa sistem operasi boleh menggunakan sistem bantuan silang platform yang berjalan di penyemak imbas Web pengguna. Mana-mana alat pengarang bantuan yang anda gunakan harus menyokong format bantuan yang akan anda buat untuk membuat fail bantuan
Langkah 3. Buat fail projek bantuan
Alat pengarang bantuan anda akan membuat fail projek bantuan untuk anda, berdasarkan nama fail yang anda berikan dan maklumat lain. Fail projek utama mengandungi maklumat mengenai fail lain, yang merangkumi fail kandungan, fail indeks, satu atau lebih fail gambar dan fail lain.
- Fail kandungan merangkumi teks dalam fail bantuan yang menerangkan bagaimana aplikasi perisian yang anda dokumentasikan berfungsi. Teks biasanya dipecah menjadi topik yang merangkumi skrin, ciri atau prosedur tertentu.
- Fail indeks adalah senarai topik fail bantuan. Ini digunakan untuk membuat daftar isi yang dapat digunakan pengguna untuk memilih topik yang akan dilihat, serta indeks yang dapat dicari dalam file bantuan.
- Fail gambar adalah fail grafik dari layar program atau bahagian dari skrin yang dipaparkan dalam fail bantuan untuk meningkatkan kemampuan pengguna untuk memahami apa yang dimaksudkan oleh teks fail bantuan.
Langkah 4. Laraskan ukuran tetingkap bantuan
Kecuali anda menulis fail bantuan untuk muncul di penyemak imbas Web pengguna, fail bantuan akan muncul di tetingkapnya sendiri. Alat pengarang bantuan anda akan membolehkan anda menyesuaikan dimensi mendatar dan menegak tetingkap kepada ukuran yang membolehkan pengguna akhir membaca fail bantuan tanpa menghalangi aplikasi itu sendiri. Tetingkap pertolongan utama selalunya dalam format tri-panel, dengan senarai isi di sebelah kiri dan topik yang dipilih di sebelah kanan.
Fail bantuan juga dapat memiliki, selain jendela utama, tetingkap sekunder yang menggambarkan ciri tertentu secara terperinci dan secara automatik ukuran tetingkap pop timbul yang memberikan gambaran ringkas mengenai ciri. Fail bantuan juga dapat menyertakan teks tertanam yang muncul hanya ketika teks yang disorot atau butang diklik
Langkah 5. Tulis topik bantuan
Untuk melakukan ini, anda perlu mengkaji spesifikasi atau program itu sendiri untuk membuat topik untuk mendokumentasikan skrin dan ciri program. Semasa anda membuat setiap topik, alat pengarang bantuan anda akan menambahkannya ke jadual kandungan dan indeks fail bantuan.
- Walaupun anda dapat membuat senarai kandungan semasa anda pergi, ada baiknya anda mempunyai rancangan bagaimana mengaturnya. Anda boleh menyusun daftar kandungan di sekitar skrin program, ciri-cirinya, cara menggunakannya atau gabungannya.
- Semasa anda menulis topik, pertimbangkan maklumat lain dalam fail bantuan yang ingin pengguna akses cepat. Anda boleh membuat lompatan, atau hiperpautan, dalam teks fail bantuan yang bersambung dengan topik yang mempunyai maklumat tersebut.
Langkah 6. Sertakan tangkapan skrin, jika diperlukan
Banyak ciri program dijelaskan dengan baik dengan kombinasi teks dan grafik. Anda boleh membuat tangkapan skrin dengan aplikasi yang disertakan dengan alat pengarang bantuan anda atau dengan aplikasi yang terpisah, seperti Microsoft Paint, Paint Shop Pro atau SnagIt.
- Teks dan tangkapan skrin harus disusun bersama dalam topik sehingga pengguna dapat melihat tangkapan layar dan teks sokongannya tanpa menatal yang tidak sepatutnya. Dalam banyak kes, anda mahu menunjukkan sebahagian daripada skrin program dan bukan keseluruhan skrin, atau menunjukkan tangkapan skrin dalam ukuran yang lebih kecil daripada yang asal. Aplikasi tangkapan skrin anda seharusnya dapat mengubah saiz tangkapan skrin tanpa kabur atau hilang perincian.
- Sekiranya anda menjangkakan perubahan pada antara muka pengguna antara versi ujian dan versi akhir program, anda mungkin mahu menangguhkan membuat tangkapan skrin sehingga anda mempunyai versi akhir program yang boleh digunakan.
Langkah 7. Buat fail peta, jika diperlukan
Beberapa program merangkumi butang "Bantuan" bagi pengguna untuk mengklik dan memaparkan topik dalam fail bantuan yang secara khusus menerangkan bagaimana layar berfungsi. Menampilkan topik dengan cara ini disebut bantuan peka konteks dan memerlukan membuat fail peta untuk pengaturcara untuk menghubungkan butang "Bantuan" ke topik tertentu dalam fail bantuan anda. Alat pengarang bantuan anda boleh membuatnya untuk anda, atau pengaturcara dapat membuat kod dan memberikannya kepada anda untuk disertakan dalam fail bantuan.
Langkah 8. Susun fail bantuan
Menyusun membuat fail bantuan sebenar yang akan disertakan dengan program. Untuk kebanyakan format bantuan, ini akan merangkumi semua fail komponen yang dibuat semasa anda membuat fail bantuan, walaupun beberapa format bantuan yang tidak disusun juga memerlukan fail topik bantuan individu untuk disertakan dengan program.
Langkah 9. Uji fail bantuan
Sebaik sahaja anda menyusun fail bantuan, anda perlu mengujinya untuk memastikan bahawa semua pautan hiper menghubungkan ke topik yang sepatutnya dan semua grafik dipaparkan dengan betul. Fail bantuan juga perlu diuji untuk memastikan bahawa kandungannya tepat dan sesuai untuk pengguna dan dalam format yang konsisten. Anda ingin menyemak sendiri fail bantuan dan meminta orang yang menguji aplikasi juga menyemaknya.
Pada projek fail bantuan yang lebih besar, penyusunan dan pengujian adalah proses berterusan. Anda ingin menyusun fail bantuan dan memeriksa kerja anda beberapa kali sebelum membuat versi terakhir
Langkah 10. Berikan fail bantuan kepada pembangun untuk disertakan dengan program
Bergantung pada sifat projek dan format fail bantuan, anda mungkin perlu memberikan beberapa fail kepada pembangun, termasuk fail peta jika terdapat topik yang sensitif konteks.
