Meskipun sering diabaikan oleh banyak pengguna komputer, file bantuan memberikan informasi penting tentang cara menggunakan aplikasi perangkat lunak yang terkait dengannya. Dengan mengklik "Bantuan", pengguna dapat memperoleh gambaran umum tentang fitur program, deskripsi layar yang dilihatnya, petunjuk tentang cara menggunakan program untuk melakukan tugas tertentu, atau membaca daftar pertanyaan umum tentang program dan jawabannya. Menulis file bantuan membutuhkan kemampuan untuk bekerja dengan aplikasi perangkat lunak dan kemampuan untuk menjelaskan berbagai hal dengan cara yang dapat dipahami pengguna.
Langkah
Langkah 1. Dapatkan salinan perangkat lunak yang akan Anda dokumentasikan
Jika memungkinkan, Anda juga harus mendapatkan salinan spesifikasi tertulis untuk program tersebut, meskipun tidak semua pengembang perangkat lunak bekerja dengannya. Dalam beberapa kasus, programmer akan menyimpang dari spesifikasi, berdasarkan waktu pengembangan yang singkat atau tidak dapat mengkodekan fitur tertentu.
Langkah 2. Dapatkan alat bantu authoring
Meskipun dimungkinkan untuk membuat file bantuan dengan tangan, menggunakan file rich-text-format (.rtf), sebagian besar pembuat file bantuan menggunakan aplikasi perangkat lunak untuk menulis file bantuan mereka, seperti RoboHelp, Help and Manual, Doc-To -Help, MadCap Flare atau HelpLogix. Sebagian besar alat bantu authoring termasuk editor teks atau bekerja dengan program pengolah kata seperti Microsoft Word dan menyediakan antarmuka pengguna yang memungkinkan penulis bantuan melihat bagaimana file bantuan akan terlihat saat dia menulisnya saat menulis kode komputer di belakang layar untuk membuat file bantuan berfungsi. Beberapa alat pembuat bantuan juga menyertakan editor grafis untuk membuat tangkapan layar untuk disertakan dalam file bantuan.
Ada beberapa format file bantuan: Yang paling umum adalah Bantuan HTML, yang digunakan oleh aplikasi yang berjalan di Windows. (Format lama, WinHelp, tidak lagi didukung.) Apple dan Unix masing-masing memiliki formatnya sendiri, seperti halnya Sun Microsystems, dengan JavaHelp-nya. Aplikasi perangkat lunak yang dirancang untuk berjalan di bawah beberapa sistem operasi dapat menggunakan sistem bantuan lintas platform yang berjalan di browser Web pengguna. Alat pembuat bantuan apa pun yang Anda gunakan harus mendukung format bantuan yang akan Anda gunakan untuk membuat file bantuan
Langkah 3. Buat file proyek bantuan
Alat pembuat bantuan Anda akan membuat file proyek bantuan untuk Anda, berdasarkan nama file yang Anda berikan dan informasi lainnya. File proyek utama berisi informasi tentang file lain, yang mencakup file konten, file indeks, satu atau lebih file gambar, dan file lainnya.
- File konten menyertakan teks dalam file bantuan yang menjelaskan cara kerja aplikasi perangkat lunak yang Anda dokumentasikan. Teks biasanya dipecah menjadi topik yang mencakup layar, fitur, atau prosedur tertentu.
- File indeks adalah daftar topik file bantuan. Ini digunakan untuk membuat daftar isi yang dapat digunakan pengguna untuk memilih topik yang akan dilihat, serta indeks yang dapat dicari di dalam file bantuan.
- File gambar adalah file grafik dari layar program atau bagian dari layar yang ditampilkan dalam file bantuan untuk meningkatkan kemampuan pengguna untuk memahami apa yang dimaksud dengan teks file bantuan.
Langkah 4. Sesuaikan ukuran jendela bantuan
Kecuali Anda menulis file bantuan untuk muncul di browser Web pengguna, file bantuan akan muncul di jendelanya sendiri. Alat pembuat bantuan Anda akan memungkinkan Anda menyesuaikan dimensi horizontal dan vertikal jendela ke ukuran yang memungkinkan pengguna akhir membaca file bantuan tanpa menghalangi aplikasi itu sendiri. Jendela bantuan utama sering kali dalam format tiga panel, dengan daftar isi di sebelah kiri dan topik yang dipilih di sebelah kanan.
File bantuan juga dapat memiliki, selain jendela utama, jendela sekunder yang menjelaskan fitur tertentu secara detail dan secara otomatis mengukur jendela pop-up yang memberikan deskripsi singkat tentang fitur. File bantuan juga dapat menyertakan teks yang disematkan yang hanya muncul saat teks yang disorot atau tombol diklik
Langkah 5. Tulis topik bantuan
Untuk melakukan ini, Anda harus meninjau spesifikasi atau program itu sendiri untuk membuat topik untuk mendokumentasikan layar dan fitur program. Saat Anda membuat setiap topik, alat pembuat bantuan Anda akan menambahkannya ke daftar isi dan indeks file bantuan.
- Meskipun Anda dapat membuat daftar isi sambil berjalan, ada baiknya Anda memiliki beberapa rencana tentang cara mengaturnya. Anda dapat mengatur daftar isi di sekitar layar program, fitur-fiturnya, cara menggunakannya atau kombinasinya.
- Saat Anda menulis topik, pertimbangkan informasi lain dalam file bantuan yang ingin diakses pengguna dengan cepat. Anda dapat membuat lompatan, atau hyperlink, dalam teks file bantuan yang terhubung ke topik yang memiliki informasi tersebut.
Langkah 6. Sertakan tangkapan layar, jika perlu
Banyak fitur program paling baik dijelaskan dengan kombinasi teks dan grafik. Anda dapat membuat tangkapan layar dengan aplikasi yang disertakan dengan alat bantu pembuatan Anda atau dengan aplikasi terpisah, seperti Microsoft Paint, Paint Shop Pro, atau SnagIt.
- Teks dan tangkapan layar harus diletakkan bersama dalam topik sehingga pengguna dapat melihat tangkapan layar dan teks pendukungnya tanpa menggulir secara tidak semestinya. Dalam banyak kasus, Anda ingin menampilkan sebagian layar program alih-alih seluruh layar, atau menampilkan tangkapan layar dalam ukuran yang lebih kecil dari aslinya. Aplikasi tangkapan layar Anda harus mampu mengubah ukuran tangkapan layar tanpa kabur atau kehilangan detail.
- Jika Anda mengantisipasi perubahan pada antarmuka pengguna antara pengujian dan versi final program, Anda mungkin ingin menunda pembuatan tangkapan layar hingga Anda memiliki versi final program untuk dikerjakan.
Langkah 7. Buat file peta, jika diperlukan
Beberapa program menyertakan tombol "Bantuan" bagi pengguna untuk mengklik dan menampilkan topik dalam file bantuan yang secara khusus menjelaskan cara kerja layar tersebut. Menampilkan topik dengan cara ini disebut bantuan peka-konteks dan memerlukan pembuatan file peta bagi pemrogram untuk menautkan tombol "Bantuan" ke topik tertentu dalam file bantuan Anda. Alat pembuat bantuan Anda dapat membuatnya untuk Anda, atau programmer dapat mengkodekannya dan memberikannya kepada Anda untuk disertakan dalam file bantuan.
Langkah 8. Kompilasi file bantuan
Kompilasi membuat file bantuan aktual yang akan disertakan dengan program. Untuk sebagian besar format bantuan, ini akan menggabungkan semua file komponen yang dibuat saat Anda membuat file bantuan, meskipun beberapa format bantuan yang tidak dikompilasi juga memerlukan file topik bantuan individual untuk disertakan dengan program.
Langkah 9. Uji file bantuan
Setelah Anda mengkompilasi file bantuan, Anda perlu mengujinya untuk memastikan bahwa semua hyperlink terhubung ke topik yang seharusnya dan semua grafik ditampilkan dengan benar. File bantuan juga perlu diuji untuk memastikan bahwa kontennya akurat dan sesuai untuk pengguna dan dalam format yang konsisten. Anda akan ingin meninjau file bantuan sendiri dan meminta orang-orang yang menguji aplikasi untuk meninjaunya juga.
Pada proyek file bantuan yang lebih besar, kompilasi dan pengujian adalah proses yang sedang berlangsung. Anda akan ingin mengkompilasi file bantuan dan memeriksa pekerjaan Anda beberapa kali sebelum membuat versi final
Langkah 10. Berikan file bantuan kepada pengembang untuk disertakan dengan program
Bergantung pada sifat proyek dan format file bantuan, Anda mungkin harus menyediakan beberapa file kepada pengembang, termasuk file peta jika ada topik peka konteks.
