Itqualityassurance
- Mengapa penting untuk menghasilkan dokumentasi yang mesra pengguna?
- Apakah perbezaan antara dokumentasi pengguna dan dokumentasi sistem apa kegunaannya?
- Apa yang harus dimasukkan dalam dokumentasi pengguna?
Mengapa penting untuk menghasilkan dokumentasi yang mesra pengguna?
Bahasa dan kandungan mesra pengguna dalam dokumen menyumbang kepada keupayaan pengguna untuk memahami maklumat yang dibentangkan dan memohon maklumat tersebut seperti yang dimaksudkan.
Apakah perbezaan antara dokumentasi pengguna dan dokumentasi sistem apa kegunaannya?
Dokumentasi sistem mewakili dokumen yang menggambarkan sistem itu sendiri dan bahagiannya. Ia termasuk dokumen keperluan, keputusan reka bentuk, penerangan seni bina, kod sumber program, dan Soalan Lazim. Dokumentasi pengguna merangkumi manual yang disediakan terutamanya untuk pengguna akhir produk pentadbir produk dan sistem.
Apa yang harus dimasukkan dalam dokumentasi pengguna?
Dokumentasi pengguna yang hebat harus termasuk: bahasa biasa, kesederhanaan, visual, tumpuan pada masalah, hierarki dan aliran logik, jadual kandungan, kandungan yang boleh dicari, kandungan yang boleh diakses, reka bentuk yang baik, maklum balas dari pengguna sebenar, dan pautan ke sumber selanjutnya.
