Dokumentasi sistem terdiri daripada bahan bertulis yang digunakan untuk menerangkan penggunaan perkakasan komputer atau sistem perisian. Dokumentasi boleh dipaparkan sebagai manual bercetak, kad flash, halaman web atau teks bantuan pada skrin. Dokumentasi sistem adalah komponen penting dalam kejayaan sistem komputer mana pun. Walau bagaimanapun, banyak pemaju mempunyai masa yang sukar untuk mencipta dokumentasi yang mencukupi untuk produk mereka. Jenis dokumentasi yang berbeza mempunyai objektif yang berlainan, jadi kandungan dokumentasi mana pun bergantung pada khalayak yang dimaksudkan.
Dokumentasi Projek
Tujuan dokumentasi projek menggambarkan projek secara keseluruhan. Dokumentasi projek memberikan para eksekutif, pengurus dan pekerja pandangan luas tentang kaedah, sumber dan objektif yang dicadangkan oleh projek. Dokumen cadangan projek menunjukkan eksekutif tujuan dan belanjawan projek. Spesifikasi teknikal menggariskan keperluan perkakasan dan perisian untuk projek-projek. Rancangan projek memperincikan langkah-langkah programmer, juruteknik dan pereka yang akan diambil untuk mencapai objektif projek.
Dokumentasi Ujian
Dokumen ujian menggambarkan rancangan untuk menguji produk sebelum pembebasannya. Jabatan jaminan kualiti membangunkan rancangan ujian bagi pengguna "alpha" dalaman dan penguji "beta" luaran.Dokumentasi ujian termasuk arahan ujian - seperti satu set langkah tertentu penguji mesti mengikuti - untuk menentukan apakah produk berfungsi seperti yang dirancang. Kakitangan QA juga mengumpul log isu, senarai pepijat dan laporan dari penguji.
Dokumentasi Pasukan
Pertukaran idea-idea di kalangan ahli pasukan adalah penting untuk kejayaan sesuatu projek. Dokumentasi pasukan merekod pertukaran ini untuk digunakan pada projek semasa dan projek masa depan. Rancangan pasukan, jadual dan kemas kini status adalah komponen utama dokumentasi pasukan. Senarai semak membantu pengurus projek melihat tugas yang telah disiapkan oleh pasukan. Minit mesyuarat pasukan membolehkan pengurus mengesan pelbagai isu, cadangan dan tugasan di kalangan ahli pasukan.
Dokumentasi Pengguna
Unsur dokumentasi sistem yang paling penting adalah kandungan yang mencapai pelanggan. Dokumentasi pengguna mesti bebas daripada jargon teknikal yang terlalu banyak dan mengandungi bahasa yang ringkas dan ringkas. Manual pengguna biasanya merupakan komponen utama dokumentasi pengguna, tetapi pengguna juga bergantung pada sumber lain. Sumber latihan - termasuk manual dan video - dapat membantu pengguna dengan cepat dan mudah memahami bagaimana sistem berfungsi. Apabila sistem tidak berfungsi seperti yang diharapkan, panduan penyelesaian masalah dapat membantu pengguna mencari dan menyelesaikan masalah.
