Dokumentasi adalah suatu hal yang pertama harus ditentukan dan diselesaikan. hal yang penting agar dokumentasi dapat disusun dengan sukses adalah dilakukan dengan cara mengintegrasi dokumentasi ini sehingga proses dokumentasi dilakukan ketika setiap langkah development dilakkukan. Pada suatu proyek biasanya terdapat enam proses yang saling terkait dan dinamis, yaitu :
1. Pendefinisian
2. Perencanaan
3. Organisasi
4. Pengawasan
5. Penyelesaian
6. Leading
Setiap proses akan memiliki keluaran yang akan menjadi masukan bagi proses yang lainnya. Proses-proses ini memberikan beberapa keuntungan termasuk :
- Mengetahui dampak tekhnologi dan bisnis
- Menghitung estimasi biaya sesungguhnya
- Menentukan tingkat usaha
- Mencapai suatu penyelesaian yang paling efektif biayanya
- Memilih perangkat bantu dan teknik terbaik
Di dalam membangun suatu proyek rekayasa perangkat lunak terdapat proses-proses sebagai berikut :
setiap langkah-langkah dalam proses tersebut harus didokumentasikan dan diintegrasikan sesuai dengan kebutuhan proyek. disamping itu dokumentasi proyek juga meliputi :
Manual penggunaan
Bagian ini berisis manual yang memberikan petunjuk cara pengoperasian alat. Secara singkat diberikan petunjuk pemakaian dari program tersebut. Terutama tentang menu-menu dari program ini. Terdiri dari :
1. Pengantar
• Tujuan dari produk
• Lingkungan operasi
• Fungsi secara umum
• Fitur khusus
• Keterbatasan
• Keterangan dan notasi dokumen ini
2. Installasi
• Persyaratan minimal sistem yang dibutuhkan
• Menyalin dan memback-up
• Proses instalasi
• Menkon_gurasi /kustomisasi produk
3. Tutorial
• Penjelasan langkah-demi langkah dengan contoh
• Penjelasan tiap contoh
• Pengembangan dari contoh dasar
• Penggunaan Help online dan petunjuk penggunaan (manual)
4. Instruksi ditail
• Keluaran dari produk
• Masukan untuk produk
• Pengoperasian produk
• Penanganan error
• Fungsi khusus
5. Ditail teknis
• Prinsip dari operasi
• Fitur lanjutan
• Algoritma utama yang digunakan
• Struktur data utama
• Modifikasi produk
• Cara memperoleh dukungan teknis dan informasi lanjutan
Maintenance Manual
Bagian ini menerangkan tata cara perawatan dan pengelolaan sistem yang baik, agar sistem dapat beroperasi dengan aman dan memberikan fungsinya sebaik mungkin Dibagi menjadi :
1. Maintenance Manual.
Sub bagian ini hanya memberikan tentang tata cara perawatan baik secara elektris, fisis maupun perawatan perangkat lunak yang harus dilakukan.
2. Trouble shooting Manual.
Sub bagian ini memberikan petunjuk tentang yang harus dilakukan oleh pengguna sistem bila terjadi kerusakan, atau ketidak normalan kerja sistem.
3. Tingkat kerusakan yang ditulis biasanya hanyalah sampai pada level yang ringan dan tak perlu penanganan secara khusus.
