Pentingnya Dokumentasi Pengembangan Sistem

Mungkin Anda sudah sering mengerjakan proyek pengembangan sistem informasi. Misalnya saja, Anda pernah diminta untuk membuat sistem pendaftaran online. Atau barangkali, yang lebih gampang seperti membuat website untuk menampilkan berita. Atau mungkin juga belasan atau puluhan proyek lain yang sudah Anda rampungkan di masa lalu, baik atas nama sendiri maupun tim. Nah, sekarang pertanyaannya, apakah dokumentasinya masih ada?

Jangankan masih ada, dibuat saja tidak. Haha…. Mungkin itu proyek-proyek awal Anda, katakanlah satu, dua atau tiga proyek pertama Anda tanpa dokumentasi sama sekali. Oke, dimaafkan. Lalu, pertanyaannya, apakah dokumentasi yang dulu sempat Anda buat sekarang masih ada?

Saya yakin sebagian besar dokumentasinya sudah tiada entah kemana. Tidak dapat dilacak kembali. Kalaupun Anda memerlukannya lagi, sangat mungkin Anda akan merekonstruksi ulang dokumentasi tersebut. Benar? Haha, tidak usah mengelak, kecuali Anda bekerja pada sebuah perusahaan software yang sudah matang secara sistem.

Jadi begini, dokumentasi itu penting. Setidaknya menjadi sangat penting ketika sistem Anda tersebut di kemudian hari dikembangkan oleh si pemilik sistem. Entah karena kebutuhan pengguna atau perkembangan teknologi, sangat mungkin sebuah sistem informasi dilakukan penambahan atau penambalan modul di sana dan di sini.

Tanpa dokumentasi yang baik, penerus pengembangan sistem tersebut akan meraba dan menerka sintaks-sintaks serta kebutuhan pengguna yang telah lalu. Bisa saja kebutuhan pengguna yang lalu ternyata sangat berbeda dari sekarang. Bisa saja pula ada maksud-maksud penggunaan fungsi tertentu yang ternyata tidak disadari pentingnya oleh tim pengembang lanjutan.

Itu hanya salah satu contoh saja. Yang lebih penting dari itu, dokumentasi dapat menjadi alat pertanggung jawaban, baik secara hukum maupun keilmuan atas karya sistem informasi yang kita kembangkan. Bagaimana tidak, semisal pemilik proyek menuntut Anda mengapa ada fitur yang tidak dikembangkan, maka kita cukup tunjukkan project charter pada bagian cakupan proyek. Selesai. Tidak perlu lagi berpanjang kata.

Demikian pula, secara keilmuan, misalnya Anda menyatakan bahwa sistem sudah selesai kita buat. Atas dasar apa kita nyatakan sudah selesai? Tentu saja berdasar hasil pengujian sistem, penerimaan pengguna (User Acceptance Test atau UAT), serta persetujuan bahwa sistem sudah rampung dan dilanjutkan dengan pemeliharaan sistem jika memang dibutuhkan.

Kalau sudah demikian, pertanyaannya, dokumentasi yang minimal itu terdiri atas apa saja?

  1. Dokumen project charter. Untuk mudahnya, Anda bisa menggunakan yang sederhana seperti di sini: http://project-charter-template.casual.pm/
  2. Dokumen spesifikasi kebutuhan pengguna aka SRS
  3. Dokumen penjadwalan sistem. Untuk ini Anda bisa menggunakan Ms Project untuk membuat timeline. Atau kalau mau sederhana boleh juga menggunakan aplikasi spreadsheet semacam Excel atau LibreCalc.
  4. Dokumen perancangan atau model sistem. Dokumen berisi rancangan-rancangan sistem yang Anda kembangkan
  5. Dokumen pengujian sistem
  6. Dokumen manual sistem, baik dalam bentuk lengkap, ringkas, dan tentu saja pastikan Anda menyiapkan Quick Start-nya.
  7. Dokumen UAT.

Di masa mendatang, semua dokumen-dokumen tersebut insyaAllah akan bermanfaat bagi Anda serta orang-orang yang terlibat dalam pengembangan sistem.

Sekian, semoga bermanfaat. Bismillah, izin publish… hihi…

Pos ini dipublikasikan di Catatan, Developer dan tag . Tandai permalink.

Tinggalkan Balasan

Isikan data di bawah atau klik salah satu ikon untuk log in:

Logo WordPress.com

You are commenting using your WordPress.com account. Logout / Ubah )

Gambar Twitter

You are commenting using your Twitter account. Logout / Ubah )

Foto Facebook

You are commenting using your Facebook account. Logout / Ubah )

Foto Google+

You are commenting using your Google+ account. Logout / Ubah )

Connecting to %s