- program komputer yang bila dieksekusi akan memberikan fungsi dan kerja seperti yang diinginkan.
- struktur data yang memungkinkan program memanipulasi informasi secara proposional, dan
- dokumen yang menggambarkan operasi dan kegunaan program.
Sehingga dapat dikatakan sebuah program komputer belum dapat disebut perangkat lunak tanpa disertai dengan dokumentasinya. Hal ini menunjukkan betapa pentingnya dokumentasi pada pembuatan sebuah perangkat lunak, tetapi banyak pengembang perangkat lunak yang kurang memperhatikan masalah dokumentasi. Dokumentasi merupakan sebuah artefak yang tujuannya untuk menyampaikan informasi tentang sistem perangkat lunak yang menyertainya.
Selain itu dokumentasi mempunyai fungsi sebagai berikut :
1. Bertindak sebagai media komunikasi antar anggota pengembang tim,
2. Penyimpanan sistem informasi untuk digunakan oleh maintenance engineers,
3. Membantu manajer proyek dalam merencanakan, mengatur anggaran, dan penjadwalan dalam proses pembangunan perangkat lunak,
4. Memberi penjelasan kepada pengguna bagaimana cara menggunakan dan mengelola sistem yang dibangun.
Sebagai tempat penyimpanan informasi, dokumen semestinya harus berisi informasi yang lengkap, valid, mudah dimengerti, dan up-to-date. Tapi sayangnya banyak pengembang yang membiarkan dokomen yang dibuat tidak memberikan informasi yang lengkap atau informasi yang tidak diperbaharui (out-of-date).
Beberapa software engineers berpendapat bahwa “my code is self-documenting”. Mereka beranggapan cukup dengan source code sudah merupakan dokumentasinya, sehingga tidak diperlukan dokumen tambahan. Hal ini mungkin dapat berlaku jika program yang dibuat untuk dirinya sendiri. Tetapi bagaimana jika program tersebut digunakan oleh orang lain atau program tersebut sebagai bagian dari sebuah sistem perangkat lunak yang dikerjakan oleh banyak orang ? Software engineers yang lain mungkin dapat mengerti jalannya program dengan membaca kode tersebut, tetapi tetap akan membutuhkan waktu yang lebih lama dibandingkan dengan membaca sebuah dokumen yang menjelaskan secara rinci tetang program tersebut. Scott Ambler dalam thesis Andrew Forward menjelaskan hubungan antara source code, model, dokumen, dan dokumentasi. Ambler menjelaskan bahwa sebuah dokumentasi merupakan penjelasan dari kode yang dibuat. Sebuah model juga mungkin menjelaskan kode, dan model ini dapat menjadi dokumen atau bagian dari dokumen. Hubungan tersebut dapat dilihat pada gambar berikut.
Tidak ada komentar:
Posting Komentar