Sistematika Dokumentasi dari Perancangan Sampai Implementasi
Sistematika Dokumentasi dari Perancangan Sampai Implementasi - Menurut Roger S. Pressman [1], ada tiga hal yang dapat mendefinisikan suatu perangkat lunak yaitu:
Dokumentasi merupakan sebuah artefak yang tujuannya untuk menyampaikan informasi tentang sistem perangkat lunak yang menyertainya . Selain itu dokumentasi mempunyai fungsi sebagai berikut :
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:
Ian Sommerville mengklasifikasi dokumentasi ke dalam dua kelas, yaitu dokumentasi proses dan dokumentasi produk
.
Dokumentasi proses merupakan dokumen yang menyimpan semua proses dari pembangunan dan pemeliharaan perangkat lunak, termasuk perencanaan, penjadwalan, lembar kerja, serta memo maupun email.
Sedangkan dokumen produk yaitu dokumen yang merupakan penjelasan dari perangkat lunak yang dibangun. Dokumentasi pengguna dan dokumentasi sistem termasuk dalam dokumen produk. Dokumentasi pengguna yaitu dokumen yang menjelaskan tentang bagaimana penggunaan dari produk perangkat lunak tersebut, sedangkan dokumen sistem yaitu semua dokumen yang menjelaskan tentang sistem yang dibagun, mulai dari spesifikasi kebutuhan sampai dengan pengujian perangkat lunak.
Pada sumber lain ada yang mengklasifikasikan dokumentasi ke dalam empat bagian yaitu dokumen kebutuhan, arsitektur dan desain, dokumen teknis, dokumen end user, dan dokumen pemasaran. Dokumen kebutuhan merupakan dokumen yang menjelaskan tentang atribut, kemampuan, karakterisitik, atau kualitas dari suatu sistem yang merupakan dasar dari pembuatan suatu perangkat lunak. Dokumen arsitektur dan disain yaitu dokumen yang menjelaskan tentang arsitektur sistem dan prinsip – prinsip konstruksi yang akan digunakan dalam desain komponen perangkat lunak. Dokumen teknis merupakan dokumentasi dari kode, algoritma dan interface. Dokumen end user merupakan dokumen manual tentang bagaimana perangkat lunak tersebut digunakan. Dokumen pemasaran berisi bagaimana cara pemasaran dari produk dan analisis permintaan pasar.
Dokumen Persyaratan Perangkat Lunak
Dokumen persyaratan perangkat lunak (SRS/Software Requirements Specification) merupakan persyaratan resmi mengenai apa yang dituntut dari pengembang sistem [7]. Dokumen berisi persyaratan user untuk sistem dan spesifikasi secara rinci dari persyaratan sistem. Berikut ilustrasi contoh dokumen persyaratan perangkat lunak dan bagaimana pemanfaatannya [7].
Heninger dalam buku Ian Sommerville [7] mengusulkan bahwa ada enam persyaratan yang harus dipenuhi oleh dokumen persyaratan perangkat lunak yaitu:
Lembaga IEEE telah membuat standar untuk dokumen persyaratan perangkat lunak (IEEE/ANSI 830-1993). Berikut outline yang disarankan oleh IEEE untuk dokumen persyaratan perangkat lunak:
Persyaratan khusus mencakup persyaratan fungsional, non-fungsional dan interface yang merupakan bagian penting dari dokumen persyaratan perangkat lunak. Standar dari IEEE memberikan saran apa saja yang perlu ditulis di dokumen persyaratan perangkat lunak, tetapi pemanfaatannya tergantung dari kebutuhan pengembang dan pengguna perangkat lunak
tersebut.
Dokumentasi Desain
Dokumentasi desain berisi penjelasan rinci tentang inti teknis dari rekayasa perangkat lunak yang meliputi struktur data, arsitektur program, interface dan detail prosedural [1]. Gambar 3 menunjukan contoh outline dari dokumen desain yang diambil dari buku Pressman [1]. Berikut penjelasan perbagian dari Pressman mengenai outline tersebut:
Dokumentasi Pengujian
Pengujian perangkat lunak merupakan sederetan langkah yang digunakan untuk melakukan pengujian atau pengecekan terhadap unit program ataupun sistem lengkap dari perangkat lunak untuk menjamin bahwa persyaratan sistem telah dipenuhi. Pengujian memastikan bahwa program tersebut telah berfungsi sebagaimana mestinya. Rencana, hasil serta prosedur pengujian harus didokumentasikan dalam suatu dokumen pengujian. Gambar 5 menunjukkan outline dari dokumen pengujian.
Dokumentasi Pengguna
Dokumentasi pengguna merupakan dokumen yang menyertai sebuah perangkat lunak yang berisi penjelasan secara detail tentang perangkat lunak tersebut. Dokumen pengguna menjelaskan setiap feature dari perangkat lunak dan menjelaskan bagaimana cara menggunakan setiap feature tersebut. Selain itu dokumen pengguna juga dapat memberikan penjelasan terhadap setiap masalah atau error yang terjadi dan bagaimana cara menanganinya. Dokumen pengguna dapat berupa dokumen cetak, elektronik, dokumen online yang mudah diakses ataupun gabungan dari semuanya. Dengan adanya dokumen pengguna ini, pengguna dapat dimudahkan dalam menggunakan perangkat lunak tersebut.
IEEE telah mendefinisikan standar untuk dokumentasi pengguna. Pada standar tersebut, IEEE mendefinisikan komponen-komponen yang semestinya ada pada dokumentasi pengguna. Komponen yang disarankan oleh IEEE dapat dijadikan panduan untuk membuat dokumentasi pengguna.
KUALITAS DOKUMENTASI
Dokumen berkualitas bagus
Dokumen berkualitas jelek
- 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 :
- Bertindak sebagai media komunikasi antar anggota pengembang tim,
- Penyimpanan sistem informasi untuk digunakan oleh maintenance engineers,
- Membantu manajer proyek dalam merencanakan, mengatur anggaran, dan penjadwalan dalam proses pembangunan perangkat lunak,
- 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?
 |
| image source: adverbum.com |
baca juga: Konsep Pemeliharaan Perangkat Lunak dengan Melakukan Rekayasa
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:
Ian Sommerville mengklasifikasi dokumentasi ke dalam dua kelas, yaitu dokumentasi proses dan dokumentasi produk
.
Dokumentasi proses merupakan dokumen yang menyimpan semua proses dari pembangunan dan pemeliharaan perangkat lunak, termasuk perencanaan, penjadwalan, lembar kerja, serta memo maupun email.
Sedangkan dokumen produk yaitu dokumen yang merupakan penjelasan dari perangkat lunak yang dibangun. Dokumentasi pengguna dan dokumentasi sistem termasuk dalam dokumen produk. Dokumentasi pengguna yaitu dokumen yang menjelaskan tentang bagaimana penggunaan dari produk perangkat lunak tersebut, sedangkan dokumen sistem yaitu semua dokumen yang menjelaskan tentang sistem yang dibagun, mulai dari spesifikasi kebutuhan sampai dengan pengujian perangkat lunak.
Pada sumber lain ada yang mengklasifikasikan dokumentasi ke dalam empat bagian yaitu dokumen kebutuhan, arsitektur dan desain, dokumen teknis, dokumen end user, dan dokumen pemasaran. Dokumen kebutuhan merupakan dokumen yang menjelaskan tentang atribut, kemampuan, karakterisitik, atau kualitas dari suatu sistem yang merupakan dasar dari pembuatan suatu perangkat lunak. Dokumen arsitektur dan disain yaitu dokumen yang menjelaskan tentang arsitektur sistem dan prinsip – prinsip konstruksi yang akan digunakan dalam desain komponen perangkat lunak. Dokumen teknis merupakan dokumentasi dari kode, algoritma dan interface. Dokumen end user merupakan dokumen manual tentang bagaimana perangkat lunak tersebut digunakan. Dokumen pemasaran berisi bagaimana cara pemasaran dari produk dan analisis permintaan pasar.
Dokumen Persyaratan Perangkat Lunak
Dokumen persyaratan perangkat lunak (SRS/Software Requirements Specification) merupakan persyaratan resmi mengenai apa yang dituntut dari pengembang sistem [7]. Dokumen berisi persyaratan user untuk sistem dan spesifikasi secara rinci dari persyaratan sistem. Berikut ilustrasi contoh dokumen persyaratan perangkat lunak dan bagaimana pemanfaatannya [7].
Heninger dalam buku Ian Sommerville [7] mengusulkan bahwa ada enam persyaratan yang harus dipenuhi oleh dokumen persyaratan perangkat lunak yaitu:
- Menspesifikasi perilaku sistem eksternal.
- Menspesifikasi batasan – batasan implementasi.
- Mudah diubah
- Berfungsi sebagai alat bantu referensi bagi pemelihara sistem.
Lembaga IEEE telah membuat standar untuk dokumen persyaratan perangkat lunak (IEEE/ANSI 830-1993). Berikut outline yang disarankan oleh IEEE untuk dokumen persyaratan perangkat lunak:
Persyaratan khusus mencakup persyaratan fungsional, non-fungsional dan interface yang merupakan bagian penting dari dokumen persyaratan perangkat lunak. Standar dari IEEE memberikan saran apa saja yang perlu ditulis di dokumen persyaratan perangkat lunak, tetapi pemanfaatannya tergantung dari kebutuhan pengembang dan pengguna perangkat lunak
tersebut.
Dokumentasi Desain
Dokumentasi desain berisi penjelasan rinci tentang inti teknis dari rekayasa perangkat lunak yang meliputi struktur data, arsitektur program, interface dan detail prosedural [1]. Gambar 3 menunjukan contoh outline dari dokumen desain yang diambil dari buku Pressman [1]. Berikut penjelasan perbagian dari Pressman mengenai outline tersebut:
- Bagian I berisi ruang lingkup dari kerja desain.
- Bagian II berisi desain data, struktur file eksternal dan referensi silang yang menghubungkan objek data denganfile tertentu.
- Bagian III berisi desain arsitektur.
- Bagian IV dan V, pada bagian ini berkembang pada saat desain interface dan procedural dimulai.
- Bagian VI berisi referensi silang yang bertujuan utnuk menetapkan bahwa semua persyaratan dipenuhi oleh desain perangkat lunak dan menunjukkan modul mana yang krites terhadap implementasi persyaratan spesifik.
- Bagian VII berisi tahap pertama dari pembuatan dokumentasi pengujian.
- Bagian VIII dan IX berisi data tambahan meliputi deskripsi algoritma, prosedur alternative, data dalam bentuk tabel, kutipan dari dokumen lain, dan informasi relevan lainnya.
Dokumentasi Pengujian
Pengujian perangkat lunak merupakan sederetan langkah yang digunakan untuk melakukan pengujian atau pengecekan terhadap unit program ataupun sistem lengkap dari perangkat lunak untuk menjamin bahwa persyaratan sistem telah dipenuhi. Pengujian memastikan bahwa program tersebut telah berfungsi sebagaimana mestinya. Rencana, hasil serta prosedur pengujian harus didokumentasikan dalam suatu dokumen pengujian. Gambar 5 menunjukkan outline dari dokumen pengujian.
Dokumentasi Pengguna
Dokumentasi pengguna merupakan dokumen yang menyertai sebuah perangkat lunak yang berisi penjelasan secara detail tentang perangkat lunak tersebut. Dokumen pengguna menjelaskan setiap feature dari perangkat lunak dan menjelaskan bagaimana cara menggunakan setiap feature tersebut. Selain itu dokumen pengguna juga dapat memberikan penjelasan terhadap setiap masalah atau error yang terjadi dan bagaimana cara menanganinya. Dokumen pengguna dapat berupa dokumen cetak, elektronik, dokumen online yang mudah diakses ataupun gabungan dari semuanya. Dengan adanya dokumen pengguna ini, pengguna dapat dimudahkan dalam menggunakan perangkat lunak tersebut.
IEEE telah mendefinisikan standar untuk dokumentasi pengguna. Pada standar tersebut, IEEE mendefinisikan komponen-komponen yang semestinya ada pada dokumentasi pengguna. Komponen yang disarankan oleh IEEE dapat dijadikan panduan untuk membuat dokumentasi pengguna.
- Arsitektur dan informasi dokumentasi lainnya selalu valid atau setidaknya menyediakan panduan sejarah yang dapat berguna untuk pemeliharaan perangkat lunak.
- Inline comments pada kode program cukup baik dalam memberikan informasi yang berguna untuk pemeliharaan perangkat lunak.
- Dokumentasi untuk semua jenis sering sekali tidak diperbaharui (out of date)
- Sistem mempunyai terlalu banyak dokumentasi
- Penulisan dokumentasi yang buruk
- Pengguna kesulitan menemukan isi yang berguna dalam dokumentasi
- Pembuatan dokumentasi yang memakan waktu yang tidak sebanding dengan keuntungan dari dokumentasi tersebut
Dokumen berkualitas sangat buruk
Berdasarkan survei Andrew Forward [10] menunjukkan bahwa isi dokumen merupakan atribut dokumen yang paling penting dari sebuah dokumentasi perangkat lunak. Tiga atribut lainnya yang dianggap penting yaitu up-to-date, availability, use of examples. Atribut-atribut tersebut yang sangat menentukan kualitas suatu dokumen, walaupun atribut lainnya juga tidak kalah pentingnya.
ALAT BANTU
Teknologi lainnya yang digunakan pengembang berdasarkan survei tersebut yaitu Ar goUML, Visio, FrameMaker, AuthorIT, whiteboards dan digital cameras, JUnit dan XML editors. Word processors paling banyak digunakan karena merupakan tool yang gampang digunakan dan lebih fleksibel. Tool yang berguna lainnya yaitu software sejenis mindmap (freemind).
Software tersebut dapat membantu untuk pengembang dalam menuliskan dokumentasi terkait dengan pembuatan perangkat lunak.
Sekian artikel tentang Sistematika Dokumentasi dari Perancangan Sampai Implementasi. Semoga bermanfaat.
Daftar Pustaka
Berdasarkan survei Andrew Forward [10] menunjukkan bahwa isi dokumen merupakan atribut dokumen yang paling penting dari sebuah dokumentasi perangkat lunak. Tiga atribut lainnya yang dianggap penting yaitu up-to-date, availability, use of examples. Atribut-atribut tersebut yang sangat menentukan kualitas suatu dokumen, walaupun atribut lainnya juga tidak kalah pentingnya.
Teknologi lainnya yang digunakan pengembang berdasarkan survei tersebut yaitu Ar goUML, Visio, FrameMaker, AuthorIT, whiteboards dan digital cameras, JUnit dan XML editors. Word processors paling banyak digunakan karena merupakan tool yang gampang digunakan dan lebih fleksibel. Tool yang berguna lainnya yaitu software sejenis mindmap (freemind).
Software tersebut dapat membantu untuk pengembang dalam menuliskan dokumentasi terkait dengan pembuatan perangkat lunak.
Sekian artikel tentang Sistematika Dokumentasi dari Perancangan Sampai Implementasi. Semoga bermanfaat.
Daftar Pustaka
- A.S and M. Shalahuddin, Modul Pembelajaran Rekayasa Perangkat Lunak (Terstruktur dan Berorientasi Objek). Bandung:Modula, 2011.
- IEEE, IEEE Standard for Software User Documentation, IEEE-Std1063-2001. New York: Institute of Electrical and Electronics Engineers, 2001.
- C. Lethbridge, J. Singer, A. Forward, and D. Consulting, “How Software Engineers Use Documentation : The State of the Practice Documentation :,” IEEE Computer Society, pp. 35-39, 2003.
- Forward, K. Edward, and T. C. Lethbridge, “Software Engineering Documentation Priorities : An Industrial Study,” University of Ottawa, pp. 1-13, 2002.
- Najwaini, Effan and SN, Azhari, “ Dokumentasi sebagai bagian dari perangkat lunak,” Semantik 2012, ISBN 979-26-0255-0
