Memastikan Dokumentasi System Selalu Update

Setiap bidang ilmu memiliki etika atau moral sendiri sendiri, begitu juga dengan ilmu di bidang ilmu komputer sendiri. pada ilmu komputer sendiri ada salah satu mata kuliah tersendiri yang hubungannya dengan etika yait IT Ethics, law and regulation.

pada artikel kali ini akan membahas tentang technical writer yang bertugas mendokumentasikan sistem secara lengkap. sesuai dengan judulnya dokumentasi sistem khususnya open source system sangat mudah kita dapatkan dan dipelajari jika mengunduh open source system. melengkapi dokumen sistem disinilah yang akan di bahas.

Dokumentasi sistem yang baik adalah dokumentasi yang sesuai dengan sistem yang didokumentasikan dan digunakan saat ini , tidak boleh ada yang terlewat. ada sebuah contoh misalkan ada seorang technical writer yang harus mendokumentasikan sistem telah selesai melakukan tugasnya dan mendapatkan persetujuan atau tanda tangan bahwa dokumentasi telah selesai. tiba tiba datang seorang programmer diakhir waktu mengatakan pada anda bahwa ada perubahan kecil yang terjadi pada sistem yang telah anda dokumentasikan. bagaimana sikap technical writer saat ini , apakah akan kembali merevisi dokumentasi yang telah di setujui lalu minta pengesahan kembali ataukah membiarkan saja tidak perlu mengupdate dokumentasi tersebut ?

untuk menjawab permasalahan diatas melalui ilmu IT Ethics kita perlu melihat 2 buah pandangan yaitu conservative dan liberal . dengan pandangan ini nantinya kita bisa menarik kesimpulan dan kemudian memutuskan cara yang mana yang digunakan.

secara konservativ sebaiknya anda kembali untuk mengupdate dokumentasi dari sistem yang berubah tadi meskipun pekerjaan anda telah ditandatangani sebagai tanda sudah selesai, tapi perlu diingat bahwa dokumentasi sistem bukanlah dokumentasi yang dibuat saat ini saja tapi akan digunakan seterusnya sehingga dokumentasi bisa dikatakan baik jika sesuai dengan sistem yang ada. point penting kedua adalah anda tidak perlu menghabiskan waktu untuk menulis hal tersebut dikarenakan ingatan anda masih fresh tentang dokumentai yang berubah tersebut, beda halnya jika anda tunda-tunda maka ketika anda akan mendokumentasikan kemungkinan anda bisa terlupa dan harus membuka kembali dokumentasi lama.

Secara liberal, anda sebaiknya menunda dahulu untuk mengupdate dokumentasi , memastikan sampai sistem tidak ada perubahan kembali. hal ini berhubungan dengan target pekerjaan anda, jika anda layani setiap perubahan yang ada maka bisa jadi pekerjaan anda seolah olah tidak pernah selesai. jika ada perubahan sistem sebaiknya dilakukan version dan update dari dokumentasi sehingga tidak merubah2 dokumentasi yang ada.

Berdasarkan pembahasan diatas dari sudut pandang IT Ethics , maka baik konservatif ataupun liberal anda harus mengupdate dokumentasi dari sebuah sistem , karena dokumentasi ini akan sangat dibutuhkan sekali saat terjadi system failure atau anda akan melakukan system restore yang membutuhkan dokumentasi system dari seorang technical writer secara lengkap.