Menggunakan People VS Pengguna dalam dokumentasi dan pedoman online

1. Mengapa penting untuk menghasilkan dokumentasi yang ramah pengguna?
2. Apa perbedaan antara dokumentasi pengguna dan dokumentasi sistem apa kegunaannya?
3. Apa yang harus dimasukkan dalam dokumentasi pengguna?

Mengapa penting untuk menghasilkan dokumentasi yang ramah pengguna?

Bahasa dan konten yang ramah pengguna dalam dokumen berkontribusi pada kemampuan pengguna untuk memahami informasi yang disajikan dan untuk menerapkan informasi tersebut sebagaimana dimaksud.

Apa perbedaan antara dokumentasi pengguna dan dokumentasi sistem apa kegunaannya?

Dokumentasi sistem mewakili dokumen yang menggambarkan sistem itu sendiri dan bagian -bagiannya. Ini termasuk dokumen persyaratan, keputusan desain, deskripsi arsitektur, kode sumber program, dan FAQ. Dokumentasi pengguna mencakup manual yang terutama disiapkan untuk pengguna akhir dari administrator produk dan sistem.

Apa yang harus dimasukkan dalam dokumentasi pengguna?

Dokumentasi pengguna yang hebat harus mencakup: bahasa sederhana, kesederhanaan, visual, fokus pada masalah, hierarki dan aliran logis, daftar konten, konten yang dapat dicari, konten yang dapat diakses, desain yang baik, umpan balik dari pengguna nyata, dan tautan ke sumber daya lebih lanjut.