Keterangan
Dokumentasi Manual Pengguna (MP) adalah dokumen yang bertindak sebagai panduan dan rujukan untuk pengguna memahami dan menggunakan aplikasi yang siap dibangunkan. Ianya mengandungi maklumat mengenai langkah-langkah penggunaan dan pengoperasian aplikasi secara terperinci.
Apabila berlaku sebarang perubahan atau penambahbaikan ke atas aplikasi, dokumen manual pengguna yang sedia ada perlulah kemaskini. Segala perubahan yang dilakukan pada dokumen manual pengguna mestilah direkodkan dan versi dokumen juga perlu dikemaskini. Rujuk kepada D17 Manual Pengguna Sistem untuk melihat format dokumen Manual Pengguna Sistem di mana pengisian kandungan-kandungannya adalah seperti langkah-langkah di bawah.
Objektif
- Membantu pengguna sistem untuk memahami proses kerja dan menggunakan setiap modul di dalam sistem dengan lancar dan sempurna.
- Mewujudkan kesinambungan dalam penggunaan dan pengoperasian sistem aplikasi.
- Memudahkan latihan pengguna dan latihan operasi dilaksanakan kepada pegawai-pegawai yang bertanggungjawab ke atas sistem aplikasi dari semasa ke semasa.
Langkah-langkah
Langkah 1 : Sediakan Pengenalan Bagi Sistem Yang Akan Dilaksanakan
Bahagian ini mengandungi perkara-perkara seperti berikut:
a) Tujuan dan Skop
Seksyen ini menerangkan tentang tujuan dan skop sistem aplikasi yang akan dilaksanakan.
b) Organisasi Manual
Seksyen ini menerangkan tentang bagaimana manual pengguna di susun untuk kemudahan pengguna.
c) Maklumat Untuk Dihubungi
Seksyen ini menerangkan tentang maklumat organisasi dan kakitangan yang boleh dihubungi dalam membantu pengguna berkaitan dengan penggunaan sistem. Jika kemudahan khidmat bantuan (helpdesk) di sesebuah organisasi adalah disediakan, maka ia perlu dijelaskan di bahagian ini.
d) Rujukan Projek
Seksyen ini menerangkan tentang bibliografi rujukan projek utama dan serahan yang telah dihasilkan sepanjang tempoh projek.
e) Fungsi Utama Sistem
Seksyen ini menjelaskan mengenai perspektif bisnes dan tanggungjawab pengguna yang akan disokong oleh sistem. Fungsi-fungsi bisnes perlu dijelaskan supaya pengguna dapat memahami objektif utama sistem aplikasi itu dibangunkan.
Langkah 2 : Sediakan Gambaran Keseluruhan Sistem
Bahagian ini memberikan gambaran keseluruhan ringkas mengenai sistem dan keupayaannya yang merangkumi perkara-perkara seperti berikut:
a) Tujuan
Seksyen ini menerangkan tentang tujuan sistem aplikasi dibangun dan dilaksanakan.
b) Keterangan Sistem
Seksyen ini memberikan gambaran keseluruhan mengenai keupayaan sistem, fungsi dan operasi serta fungsi peringkat tinggi yang akan dijalankan oleh sistem. Penggunaan gambarajah dan jadual boleh digunakan jika ia bersesuaian.
Langkah 3 : Sediakan Keterangan Fungsi Sistem
Bahagian ini menerangkan tentang setiap fungsi yang ada di dalam sistem. Ia akan menggambarkan berkenaan dengan konvensyen yang digunakan dalam subseksyen yang berkaitan. Bab ini merangkumi perkara-perkara seperti berikut :
a) Senarai Fungsi Sistem
Seksyen ini menyenaraikan nama bagi setiap fungsi yang ada di dalam sistem.
b) Perincian Keterangan Bagi Fungsi Sistem
Seksyen ini menyediakan keterangan secara terperinci bagi setiap fungsi sistem seperti berikut :
- Tujuan dan kegunaan fungsi sistem
- Pengawalan fungsi sistem, jika berkenaan
- Pilihan pelaksanaan yang berkaitan dengan fungsi sistem
- Keterangan input fungsi
- Keterangan output dan hasil yang diharapkan
- Hubungan dengan fungsi sistem yang lain
- Ringkasan operasi fungsi sistem
Langkah 4 : Sediakan Arahan Penggunaan Sistem
Bahagian ini menyediakan arahan terperinci langkah demi langkah bagi kaedah pengoperasian sistem.
a) Log Masuk Sistem
Seksyen ini menerangkan berkaitan prosedur untuk log masuk sistem dan kawalan paparan sistem, seperti skrin menu utama sistem. Prosedur pengawalan hendaklah menerangkan bagaimana untuk menentukan mod yang diperlukan operasi dan menetapkan apa-apa parameter permulaan yang diperlukan untuk operasi. Prosedur pemasangan perisian perlu dimasukkan jika perisian diedarkan pada disket dan perlu dimuat turun terlebih dahulu sebelum digunakan.
b) Proses Pengoperasian Sistem
Seksyen ini menerangkan berkaitan prosedur untuk melaksanakan operasi perisian di mana tindak balas daripada pengguna diperlukan.
c) Penamatan dan Pengoperasian Semula Sistem
Seksyen ini menerangkan tentang prosedur untuk penamatan operasi sistem secara normal dan tidak berjadual bagi sistem. Di samping itu, ia juga perlu menentukan cara untuk memulakan semula sistem selepas operasi sistem ditamatkan.
Langkah 5 : Sediakan Maklumat Pengendalian Ralat
Bahagian ini menerangkan berkaitan mesej ralat dan kemudahan bantuan yang disediakan kepada pengguna. Ia merangkumi perkara-perkara seperti berikut:
a) Menyatakan mesej ralat dan kemudahan bantuan. Maklumat tambahan dan subseksyen boleh ditambah seperti yang diperlukan. Masukkan senarai semua mesej ralat seperti berikut:
- Mana-mana kod ralat angka yang berkaitan dengan mesej ralat
- Keterangan makna mesej ralat
- Perbincangan bagaimana untuk menyelesaikan ralat Bantuan Helpdesk
b) Menerangkan apa-apa perisian bantuan atau apa-apa kemudahan khidmat bantuan atau kontraktor bantuan yang pengguna boleh hubungi untuk menyelesaikan ralat. Nombor telefon meja bantuan hendaklah dimasukkan.
Rujukan
- http://www.arbowebforest.com/android/ArboWebForestUserManual.pdf
- https://www.utdallas.edu/~chung/CS4351/.../TeamInitech/Technical_Manual_v2.docx