| software documentation | dokumentasi perisian | Teknologi Maklumat | Perisian | Dokumentasi kod sumber dan teks yang ditulis berserta perisian komputer. Dokumentasi ini menerangkan cara perisian tersebut digunakan. Dokumentasi merupakan salah satu aktiviti yang penting dalam kejuruteraan perisian. Beberapa jenis dokumentasi adalah seperti yang berikut: i) Dokumentasi reka bentuk atau seni bina yang merangkumi gambaran keseluruhan pembangunan perisian, hubungan dengan persekitaran dan prinsip-prinsip pembangunan yang digunakan dalam reka bentuk komponen perisian. ii) Dokumentasi teknikal, termasuklah kod dokumentasi, algoritma, antara muka dan antara muka atur cara aplikasi (API). iii) Dokumentasi pengguna akhir, termasuklah penyediaan manual untuk pengguna, pentadbir sistem dan staf sokongan. iv) Dokumentasi pemasaran, termasuklah cara untuk memasarkan produk dan analisis bagi permintaan pasaran. |
| technical documentation | dokumentasi teknikal | Teknologi Maklumat | Perisian | Dokumentasi yang penting dalam pembangunan perisian selepas dokumentasi reka bentuk. Dokumentasi ini diperlukan terutamanya bagi pengatur cara untuk mendapatkan maklumat pelbagai aspek operasi dan algoritma yang digunakan dalam pembangunan perisian. Dokumentasi ini bukan sahaja mengandungi kod atur cara yang digunakan tetapi juga mengandungi penerangan mengenai cara perisian tersebut dilaksanakan. Selain itu, maklumat algoritma, antara muka dan antara muka atur cara aplikasi (API) juga dijelaskan dalam dokumentasi ini. |
| user documentation | dokumentasi pengguna | Teknologi Maklumat | Perisian | Dokumentasi yang memberi penerangan mengenai setiap ciri dan tujuan setiap fungsi atau atur cara dalam perisian yang dibekalkan. Dokumentasi ini dapat membantu pengguna memahami cara untuk menggunakan perisian yang disertakan dengan lebih sempurna dan berkesan. Terdapat juga dokumentasi pengguna yang memberi maklumat cara menyelesaikan masalah sekiranya terdapat kesalahan atau ketidakfungsian perisian yang digunakan. Dokumentasi ini biasanya disusun dengan sempurna mengikut indeks yang diberi agar pengguna dapat merujuk sebarang maklumat yang dikehendaki dengan mudah. Beberapa pendekatan yang kerap digunakan dalam penyediaan dokumentasi ini adalah seperti yang berikut: i) Pendekatan tutorial, iaitu pendekatan langkah demi langkah untuk melaksanakan sesuatu tugas. ii) Pendekatan bertema, iaitu pendekatan bahagian demi bahagian untuk sesuatu topik yang berkaitan. iii) Pendekatan rujukan atau indeks yang mengandungi perintah atau tugas yang disusun mengikut abjad. Penyediaan manual untuk pengguna, pentadbir sistem dan staf sokongan termasuk dalam dokumentasi pengguna ini. |
| marketing documentation | dokumentasi pemasaran | Teknologi Maklumat | Perisian | Dokumentasi yang mengandungi maklumat atau bahan promosi untuk tujuan pemasaran. Maklumat seperti kelebihan dan kemudahan perisian berbanding perisian yang lain diterangkan dalam dokumentasi pemasaran. Salah satu pendekatan yang digunakan dalam dokumentasi ini adalah dengan menyediakan ungkapan-ungkapan yang senang dan mudah diingat dan dapat menarik lebih ramai pelanggan. Ciri-ciri keserasian dalam sebarang persekitaran dan perisian merupakan perkara utama yang perlu ditekankan dalam dokumentasi ini selain maklumat pemasaran produk dan analisis bagi permintaan pasaran. |
| design documentation | dokumentasi reka bentuk | Teknologi Maklumat | Perisian | Dokumentasi dalam pembangunan perisian yang mengandungi maklumat cara sesuatu perisian dibangunkan dengan mengambil kira pelbagai keperluan pengguna dalam pelbagai peringkat. Dokumentasi ini juga memberikan penjelasan terperinci setiap pendekatan yang digunakan dalam mereka bentuk perisian dari peringkat atas hingga ke peringkat bawah. Selain itu, dokumentasi mengenai hubungan dengan persekitaran dan prinsip-prinsip pembangunan yang digunakan dalam reka bentuk komponen perisian juga dimasukkan dalam dokumentasi reka bentuk ini. |
| software installation | pemasangan perisian | Teknologi Maklumat | Perisian | Aktiviti memasang perisian dan pemacu perisian ke dalam sistem komputer. Satu pakej perisian biasanya mengandungi atur cara, pemacu dan dokumentasi pemasangan. Dokumentasi pemasangan membolehkan maklumat asas cara perisian dipasang ke dalam sistem komputer. Dalam proses pemasangan, pengguna biasanya diberi pilihan sama ada untuk memasang kesemua fungsi atau sebahagiannya dalam suatu perisian. Kaedah pemasangan berbeza antara satu perisian dengan perisian yang lain. |
| user documentation | dokumentasi pengguna | Teknologi Maklumat | Tiada | Dokumentasi yang disediakan berserta sistem bagi membantu pengguna menjalankan sistem itu. |
| programme manual | manual atur cara | Teknologi Maklumat | Tiada | Dokumentasi tentang perisian yang dibangunkan. Dokumentasi itu mengandungi tajuk, pereka bentuk perisian, keterangan input dan ouput, salinan kod sumber, helaian perubahan atur cara, dan data ujian. |
| documentation | dokumentasi | Herba | Tiada | Kaedah mengumpul, mengatur, menyimpan, merujuk dan menyebar dokumen atau maklumat bahan dan sediaan herba yang dirakam dalam salinan keras dan salinan lembut. Dokumentasi ini merupakan komponen penting dalam prosedur pengendalian piawai (SOP), Amalan Makmal Baik (GLP), Amalan Pertanian dan Pengumpulan Baik (GACP), Amalan Pengilangan Baik (APB) dan Amalan Klinikal Baik (GCP). |
| user documentation | dokumentasi pengguna | Teknologi Maklumat | Tiada | Panduan dalam bentuk bertulis atau visual yang lain mengenai sistem aplikasi seperti cara menggunakan, cara memasang, keperluan sistem komputer dan perisian. Lazimnya dokumentasi pengguna disediakan dalam bentuk bercetak (salinan keras), salinan lembut (dalam CD-ROM) dan/atau boleh dicapai menerusi Internet. Salinan lembut pula mungkin dalam bentuk dokumen HTML, PDF, Microsoft Word atau fail teks sahaja. |