Dokumentasi sistem terdiri dari bahan tertulis yang digunakan untuk menggambarkan aplikasi perangkat keras komputer atau sistem perangkat lunak. Dokumentasi dapat ditampilkan sebagai buku petunjuk yang dicetak, kartu flash, halaman Web atau teks bantuan pada layar. Dokumentasi sistem adalah komponen vital dari keberhasilan sistem komputer mana pun. Namun, banyak pengembang mengalami kesulitan membuat dokumentasi yang cukup untuk produk mereka. Berbagai jenis dokumentasi memiliki tujuan yang berbeda, sehingga konten dari dokumentasi apa pun akan bergantung pada audiens yang dituju.
Dokumentasi Proyek
Tujuan dokumentasi proyek menggambarkan proyek secara keseluruhan. Dokumentasi proyek memberikan eksekutif, manajer dan karyawan pandangan yang luas tentang metode, sumber daya, dan tujuan proyek yang diusulkan. Dokumen proposal proyek menunjukkan kepada eksekutif tujuan dan anggaran proyek. Spesifikasi teknis menguraikan persyaratan perangkat keras dan perangkat lunak untuk proyek. Rencana proyek merinci langkah-langkah yang akan dilakukan oleh programmer, teknisi dan desainer untuk mencapai tujuan proyek.
Dokumentasi Tes
Dokumen uji mengilustrasikan rencana untuk menguji produk sebelum dirilis. Departemen jaminan kualitas mengembangkan rencana pengujian untuk pengguna "alpha" internal dan penguji "beta" eksternal.Dokumentasi pengujian mencakup instruksi pengujian - seperti serangkaian langkah spesifik yang harus diikuti oleh penguji - untuk menentukan apakah produk berfungsi sesuai rencana. Staf QA juga mengumpulkan log masalah, daftar bug, dan laporan dari penguji.
Dokumentasi Tim
Pertukaran ide di antara anggota tim sangat penting untuk keberhasilan suatu proyek. Dokumentasi tim mencatat pertukaran ini untuk digunakan pada proyek saat ini dan pada proyek masa depan. Rencana tim, jadwal dan pembaruan status adalah komponen utama dari dokumentasi tim. Daftar periksa membantu manajer proyek melihat tugas-tugas yang telah diselesaikan oleh tim. Notulen rapat tim memungkinkan para manajer untuk melacak berbagai masalah, saran, dan penugasan di antara anggota tim.
Dokumentasi Pengguna
Elemen paling penting dari dokumentasi sistem adalah konten yang menjangkau pelanggan. Dokumentasi pengguna harus bebas dari jargon yang terlalu teknis dan mengandung bahasa yang jelas dan ringkas. Manual pengguna biasanya merupakan komponen utama dari dokumentasi pengguna, tetapi pengguna juga bergantung pada sumber lain. Sumber daya pelatihan - termasuk manual dan video - dapat membantu pengguna dengan cepat dan mudah memahami cara kerja sistem. Ketika sistem tidak bekerja seperti yang diharapkan, panduan pemecahan masalah dapat membantu pengguna menemukan dan menyelesaikan masalah.
