Pengembangan Dokumentasi Aplikasi
Komponen Dokumentasi Proyek yaitu :
- Pengantar
Berisi tentang penjelasan masalah dan lingkungan masalah, tujuan client, struktur organisasi dan sistem, solusi dari permasalahan yang timbul serta ruang lingkup/batasan dari solusi tersebut
- Proposal
Berisi tentang fungsi yang diberikan pada solusi yang diajukan, strategi umum untuk mengembangkan solusi, peran user dan hardware pada solusi, serta keuntungan dan kerugian solusi tersebut
- Keterbatasan Sistem/Constraint
Berisi prioritas costumer, profil user, usia pengharapan produk, prasyarat kendala, prasyarat kinerja, solusi dan ketersediaan pada lingkungan user
- Estimasi
Dalam hal ini, yang perlu diestimasikan antara lain jadwal, organisasi, budget, benefit, analisis resiko, dokumen yg diberikan, software yg dibutuhkan, fasilitas dan hardware yg dibutuhkan
- Prosedur
Tata cara/langkah-langkah untuk membuat dokumentasi
- References
Berisi tentang sumber-sumber yang dapat dijadikan pedoman untuk pembuatan dokumentasi.
Dokumentasi spesifikasi disain
Tujuan Dokumentasi Desain :
- Dokumentasi ini membantu komunikasi didalam tim desain, merepresentasikan konseptualisasi terakhir dari sistem yang baru atau pemahaman terhadap sistem yang telah ada.
- Selama proses desain kegunaan lain dari dokumentasi ini merupakan kontrol, menyediakan record dari apa yang telah dibangun dan diubah.
- Menjadi sangat penting untuk memastikan bahwa seluruh bagian dari sistem dipengaruhi oleh perubahan yang dipertimbangkan dan bahwa tanggung jawab untuk komponen-komponen dari sistem yang dipengaruhi oleh perubahan telah diberitahukan.
- Misalkan jika format file atau isi dari file diubah, maka modul program apa dan siapa saja pemrogram yang akan terpengaruh ?
- Kontrol ini juga berfungsi untuk memanggil ujicoba pelaksanaan yang lampau atau versi lama dari suatu program atau file.
- Jenis dokumentasi ini akan membentuk database yang baik untuk menentukan estimasi diwaktu mendatang mengenai berapa lama waktu yang dibutuhkan untuk membangun sistem yang serupa.
- Sistem perpustakaan program dapat menyimpan setiap track dari seluruh versi program dan memastikan bahwa pemrogram bekerja dengan versi terbaru.
User Manual
Berisi teknis/cara-cara menggunakan software tersebut. Sehingga user yang maih awam dapat mengerti cara-cara menggunakannya.
Dokumentasi Maintenance
Menjelaskan langkah-langkah merawat sistem
Dokumentasi Source code
Berisi tentang hal-hal yang berhubungan dengan software, misal compiler yang digunakan, nama pembuat, versi software, dll