1 PEMBUATAN DOKUMENTASI SOFTWARE APLIKASI PIPELINE INTEGRITY
MANAGEMENT SYSTEM TRANS GAS INDONESIA (PIMS-TGI)
Dwy Linda Sulistyaningrum 209000128
Abstract
Pipeline Integrity Management System (PIMS) is an information management application specifically for large-scale pipeline infrastructure. PIMS is built by information technology consuling company. PT. Multimedia Arto Sentosa (MAS) as the main product of the company. Pipeline Integrity Management Sytem (PIMS) is one of the application are made by PT. Multimedia Arto Sentosa (MAS) in a big software project, some documents usually has produced even before the development proses begin, like the existence of proposal for the development of specific system or software as an answer for user requirement or business strategy, and a comprehensive requirement document which defines required features or demanded behaviour from a system. Software documentation is a very important thing in a software development because software documentation can facilitate user or clien in the use of developed application by coorperation. There are many kinds documents in the process of software development, such as project plan, design specification, testing plan, etc. Process documentation and product documentation are documents which produced in a TGI project development application. Product documentation which has done in PIMS-TGI application is to make Software User Manual to facilitate user or client in understanding functions which included in PIMS-TGI application. Process documentation is a kind of documents which record development and maintenance process in a specific company application. The conducted process documentations are by making plans, schedules, process quality document, organization standard and process standard.
Keywords : PT. MAS, PIMS-TGI, Process Documentation, Product Documentation.
Pendahuluan
Setiap proyek pengembangan perangkat lunak professional tentunya menghasilkan sejumlah dokumentasi yang tidak kecil. Pengembang piranti lunak bertanggung jawab atas
2 pembuatan hampir semua jenis dokumentasi perangkat lunak walaupun kadang dibantu oleh penulis teknis profesional untuk memperindah dokumen sebelum dirilis (Keyes J. , 1950). Oleh karena itu, manajer dan Software engineer harus memperhatikan permasalahan dokumentasi dan biaya-biaya yang timbul karenanya, disamping pengembangan perangkat lunak itu sendiri. Pada proyek perangkat lunak yang besar, beberapa dokumen biasanya telah dihasilkan bahkan sebelum proses pengembangan atau pembuatan dimulai. Seperti adanya proposal untuk pembuatan sistem atau perangkat lunak tertentu sebagai jawaban dari permintaan klien ataupun strategi bisnis. Agar manajemen dapat efektif, dibutuhkan suatu kejelasan pada proses-proses yang akan dikelola. Karena perangkat lunak merupakan suatu hal yang non-fisik dan proses pembuatan perangkat lunak juga merupakan tugas-tugas pemikiran yang tidak terlihat fisik, salah satu cara agar membuat jadi jelas adalah dengan menggunakan dokumentasi (Sommerville, 2001).
Selama proses pengembangan sistem atau aplikasi, ada banyak jenis dokumen yang dapat dihasilkan antara lain: rencana proyek, spesifikasi desain, rencana pengetesan, dan lain-lain. Dokumentasi Proses dan Dokumentasi Produk merupakan dokumen yang diproduksi dalam proyek. Dokumentasi produk adalah dokumen-dokumen yang menggambarkan produk yang sedang dikembangkan (Sommerville, 2001). Dalam dokumentasi produk ini menjelaskan produk dari sudut pandang teknis dalam mengembangkan dan memelihara sistem. Dokumentasi Proses adalah dokumen-dokumen yang merekam proses pengembangan dan pemeliharaan suatu aplikasi perusahaan (Sommerville, 2001). Rencana-rencana, jadwal-jadwal, dokumen kualitas proses, standar organisasi dan standar proses merupakan bagian dari dokumentasi proses.
PT. Multimedia Arto Sentosa merupakan sebuah perusahaan konsultan yang menyediakan produk berbentuk jasa untuk membangun dan mengembangkan aplikasi sistem informasi terintegrasi khusus di bidang jalur pipa baik itu gas, maupun minyak. Setiap Aplikasi yang dibangun selalu dibuat dokumentasi aplikasi agar memudahkan user atau klien memahami proses yang telah berjalan di aplikasi tersebut. Sesuai dengan layanan yang disediakan PT. Multimedia Arto Sentosa, perusahaan yang menjadi kliennya merupakan perusahaan yang memiliki infrastruktur jalur pipa yang besar seperti Pertamina Persero.
Permasalahan yang muncul adalah saat seorang software documentation telah membuat suatu dokumentasi aplikasi, tetapi dalam kenyataanya aplikasi tersebut masih harus mengalami perubahan. Seorang software documentation harus memperbaiki dokumentasi tersebut mengikuti alur dari aplikasi yang telah dirubah sebelumnya oleh perusahaan. Untuk
3 itu seorang software documentation harus memiliki kemampuan untuk selalu memahami aplikasi yang telah dibuat oleh perusahaan agar setiap ada perubahan yang terjadi di aplikasi tersebut dapat dengan mudah diperbaiki oleh seorang software documentation.
Untuk mengetahui bagaimana penerapan teknik dokumentasi produk dan dokumentasi proses pada aplikasi Pipeline Integrity Management System Trans Gas Indonesia (PIMS-TGI), maka penulis melakukan penelitian langsung terhadap perusahaan PT. Multimedia Arto Sentosa (MAS). Penelitian ini bertujuan untuk mendapatkan gambaran mengenai penerapan teknik dokumentasi produk dan dokumentasi proses pada pembangunan aplikasi Pipeline
Integrity Management System Trans Gas Indonesia (PIMS-TGI) di PT MAS.
Pembahasan
Dokumentasi perangkat lunak merupakan satu dari banyak hal penting di dalam pembangunan perangkat lunak, proses ini akan menggambarkan bagaimana banyak komponen yang mempengaruhi untuk mengkomunikasikan informasi ke sistem perangkat lunak. Proses dokumentasi menjadi proses yang banyak digunakan dari banyak proses yang direkomendasikan untuk meningkatkan proses pengembangan sistem perangkat lunak dan membantu proses perawatan. Proses ini menjadi salah satu proses yang sudah lama digunakan dan banyak direkomendasikan. Proses dokumentasi masih memiliki banyak masalah seperti kualitas yang rendah dan data yang berlebihan, tanpa mendefinisikan tujuan, dan proses pelacakan dokumentasi ataupun proses yang mengalir antara dokumen yang tersedia dengan dokumen yang lain (Aram & Atan, 2012).
Proses dokumentasi telah memiliki standar yang sudah baku. Standar dokumentasi diterapkan pada semua dokumen yang dihasilkan dalam pengembangan perangkat lunak (Forward & Lethbridge, 2002). Dokumen tersebut harus memiliki tampilan yang konsisten (Briand, 2003). Salah satu standar yang digunakan yaitu berkaitan dengan materi yang didokumentasikan yang menyediakan informasi.
Dokumentasi dapat dianggap sebagai materi yang tertulis atau sesuatu yang menyediakan informasi tentang suatu subyek. Dokumentasi dapat berisi tentang deskripsi-deskripsi, penjelasan-penjelasan, bagan alir, daftar-daftar, cetakan hasil komputer, contoh-contoh obyek dari sistem informasi (Barker, 1992). Dokumentasi juga memiliki banyak jenis, salah satu yang banyak digunakan adalah dokumentasi program. Dokumentasi program menggambarkan logika dari program dalam bentuk bagan alir program (program flowchart),
4 tabel keputusan (decision table) dan bentuk pengendalian program. Dokumentasi program sangat dibutuhkan oleh programmer bila akan memodifikasi atau mengembangkan suatu program (Clements, 2002). Tidak hanya itu suatu aplikasi juga membutuhkan sebuah dokumentasi produk dan juga dokumentasi proses agar memudahkan user atau klien dalam mengoperasikan aplikasi tersebut (Sommerville, 2001).
Dokumentasi Produk
Dokumentasi Produk berkenaan dengan gambaran suatu produk perangkat lunak sistem yang telah jadi (Sommerville, 2001). Tidak seperti dokumentasi proses, dokumentasi produk biasanya berguna untuk waktu yang lebih lama, selama produk tersebut masih digunakan. Dokumentasi produk melingkupi dokumentasi user yang memberitahu pengguna bagaimana cara mengoperasikan produk perangkat lunak, dan dokumentasi sistem yang utamanya diperuntukkan bagi teknisi pemeliharaan. Terdapat 3 macam bentuk dokumentasi yang berhubungan dengan dokumentasi produk antara lain Software User Manual (SUM)
Software Product Specification (SPS) dan Version Description Document (VDD
(Sommerville, 2001)). Untuk memenuhi kebutuhan berbagai macam user beserta keahliannya yang masing-masing berbeda, paling tidak ada lima macam dokumen yang harus diikut sertakan dalam penyerahan suatu produk perangkat lunak atau sistem :
1. Functional description of software/system (Sommerville, 2001) Menggambarkan kebutuhan sistem untuk menjalankan program. Servis-servis yang dimiliki fitur-fitur aplikasi.
Gambaran umum dari aplikasi.
User dapat menentukan apakah aplikasi benar-benar dibutuhkan hanya dengan membaca functional description dan introductory manual.
2. The system installation document (Sommerville, 2001) Diperuntukan bagi sistem administrator.
Menyediakan informasi mendetail bagaimana cara menginstal sistem di lingkungan sistem yang spesifik.
Mencantumkan gambaran file-file apa yang membentuk suatu sistem/aplikasi.
Persyaratan minimum dari hardware yang dibutuhkan. File-file aplikasi yang harus ada sebelum sistem diinstall
5 Cara memulai sistem/aplikasi
Cara mengkonfigurasi aplikasi agar berjalan dengan sistem yang telah ada 3. The introductory manual (Sommerville, 2001)
Menyediakan pengenalan tentang sistem/aplikasi yang menggambarkan fungsi/penggunaan umum dari sistem/aplikasi tersebut.
Menjelaskan cara memulai menggunakan program aplikasi.
Menjelaskan bagaimana para user dapat menggunakan fungsi-fungsi umum yang dimiliki aplikasi disertai ilustrasi dan contoh bebas.
Mencantumkan kesalahan-kesalahan yang umum atau sering dilakukan oleh user dan cara menyelesaikannya.
4. The system reference manual (Sommerville, 2001)
Menjelaskan semua kegunaan dan fungsi yang dimiliki sistem.
Mencantumkan semua pesan kesalahan yang dimiliki sistem dan cara mengatasinya secara lengkap dan detail.
Penggunaan bahasa resmi dan teknik bisa digunakan mencantumkan secara lengkap fitur dan cara operasional dari sistem/aplikasi.
5. System administrator guide (Sommerville, 2001) Installation dan sistem reference manual.
Dalam penerapan teknik dokumentasi produk, PT. MAS menggunakan Software User
Manual (SUM) dalam pembuatan dokumentasi aplikasi Pipeline Integrity Management System Trans Gas Indonesia (PIMS-TGI). Dalam penerapan teknik dokumentasi produk
harus memiliki standard dalam hal penulisan. Untuk aplikasi PIMS TGI dokumen harus memiliki tampilan yang konsisten, dan setiap jenis atau kategori dokumen harus memiliki struktur yang konsisten. Beberapa standar produk yang seharusnya diperhatikan adalah (Sommerville, 2001) :
1. Document Identification standard
Proyek-proyek besar biasanya memproduksi sampai ribuan dokumen. Setiap dokumen harus memiliki identifikasi yang unik yang mengikuti aturan yang ditetapkan organisasi.
2. Document structure standard
Setiap kategori dokumen yang dihasilkan suatu organisasi harus memiliki struktur yang tetap/konsisten yang telah ditetapkan. Termasuk didalam struktur dokumen
6 adalah penggunaan format penomoran halaman, header dan footer, penomoran bab dan sub-bab.
3. Document presentation standards
Mengatur style tampilan dari dokumen, termasuk di dalamnya jenis huruf yang digunakan, cover, pewarnaan, penggunaan logo dan nama perusahaan
4. Document update standards
Dokumen dapat berubah dalam perkembangannya, cara yang konsisten dalam suatu update harus diatur dalam suatu proses dokumentasi. Perubahan harus teridentifikasi dan tercatat, penggunaan versi harus ada untuk mengetahui sejarah perubahan.
Gambar 1 Alur Dokumentasi Proses dan Dokumentasi Produk (Sommerville, 2001)
7 Dokumentasi Proses
Dokumentasi Proses adalah dokumen-dokumen yang merekam proses pengembangan dan pemeliharaan suatu aplikasi perusahaan (Sommerville, 2001). Rencana-rencana, jadwal-jadwal, dokumen kualitas proses, standar organisasi dan standar proses merupakan bagian dari dokumentasi proses. Terdapat beberapa kategori dalam pembuatan dokumentasi proses yakni (Bremer M. , 1955) :
Perencanaan, perkiraan dan penjadwalan. Merupakan dokumen yang dibuat oleh manajer yang digunakan untuk memprediksi dan mengontrol proses perangkat lunak.
Laporan atau Report. Merupakan dokumen yang mencatat bagaimana sumber daya digunakan selama proses pengembangan.
Standar dokumen-dokumen ini menentukan bagaimana seharusnya suatu proses diimplementasikan. Ada berbagai macam standar mulai dalam lingkup organisasi nasional bahkan internasional.
Lembar kerja atau working paper. Sering kali merupakan dokumen komunikasi teknis utama dalam suatu proyek. Merekam ide-ide dan pikiran-pikiran para teknisi yang bekerja dalam proyek, yang merupakan dokumentasi produk versi sementara yang menjelaskan strategi pengimplementasian dan penentuan masalah yang telah diidentifikasi. Seringkali dokumen ini mencatat alasan-alasan pemilihan suatu keputusan dalam desain.
Memo dan surat atau pesan elektronik. Dokumen yang merekam rincian komunikasi sehari-hari antara manajer dan development engineer.
Karakteristik utama dari dokumentasi proses adalah hampir semuanya akan menjadi kadaluarsa. Banyak informasi yang akan menjadi tidak berguna apabila telah terlewati dan normalnya tidak ada kepentingan untuk tetap menyimpannya setelah sistem atau perangkat lunak telah jadi, seperti jadwal/perencanaan pembuatan. Bagaimanapun juga tetap ada beberapa dokumentasi proses yang berguna apabila ada perubahan perangkat lunak yang diinginkan, seperti hasil testing dan lembar kerja yang mencatat alasan-alasan kenapa suatu desain dipilih dalam pembuatan suatu sistem.
Dalam penerapan teknik dokumentasi proses harus memiliki standard dalam hal penulisan. Untuk aplikasi PIMS TGI melakukan standar dokumentasi proses yang dilakukan adalah mengatur pendekatan atau metode yang harus dilakukan dalam membuat suatu dokumen. Secara umum hal ini biasanya dengan menentukan perangkat lunak yang digunakan dalam menulis suatu dokumen dan prosedur penjaminan kualitas yang dapat dilakukan untuk
8 mengukur kualitas dokumen yang dihasilkan. Standar penjaminan kualitas dokumen harus fleksibel dan dapat mencakup semua tipe dokumen yang ada dalam proyek. Dalam beberapa kasus memang tidak perlu diterapkan standar penjaminan kualitas dokumen, seperti pada dokumen lembar kerja atau memo.
Hasil Penelitian
Dalam hasil penelitian kali ini, penulis membuat sebuah panduan yaitu memberikan penjelasan kepada pengguna dalam mengoperasikan aplikasi Pipeline Integrity Management
System Trans Gas Indonesia (PIMS-TGI), serta dapat mengetahui pengertian dari setiap
modul yang ada di aplikasi tersebut.
Berikut pembahasan mengenai beberapa bagian yang ada di aplikasi PIMS-TGI seperti menu Home, modul Asset Register,modul Risk Assessment dan lain-lain. Setiap menu yang ada di aplikasi PIMS-TGI tentunya mempunya fungsi yang berbeda-beda.
Menu Home merupakan tampilan utama pada saat user berhasil login kedalam aplikasi
Pipeline Integrity Management System Trans Gas Indonesia (PIMS-TGI). Modul Asset Register merupakan fitur yang disediakan dalam aplikasi PIMS-TGI untuk mengelola data
pipeline asset yang dikelola dan dioperasikan oleh PT. Transportasi Gas Indonesia. Dibawah ini merupakan gambar dari modul Asset Register
9 Data-data yang ada didalam modul Asset Register dibangun sesuai dengan data kondisi terakhir yang ada, serta akan terus berkembang sesuai dengan perkembangan dan hasil inspeksi jaringan pipa yang di update ke dalam sistem.
Modul Risk Assessment merupakan fitur yang disediakan didalam aplikasi PIMS-TGI ini untuk memproses data hasil dari kegiatan inspeksi Risk Assessment yang dilaksanakan oleh tim inspeksi dilapangan terhadap kondisi yang ada pada jalur pipa yang dikelola. Dibawah ini merupakan gambar dari modul Risk Assessment.
Tahapan kerja pada pemprosesan data yang ada dimodul ini telah dibangun sesuai dengan metode yang digunakan di PT. Transportasi Gas Indonesia.
Kesimpulan
Dalam pembuatan dokumentasi perangkat lunak PIMS-TGI diperlukan beberapa hal yang harus dilakukan yaitu :
1. Mempelajari alur aplikasi. Mengerti bagaimana caranya membaca sebuah alur aplikasi yang nantinya akan dibuat dokumentasinya. Dimulai dari log-in aplikasi sampai dengan mencoba semua modul-modul yang terdapat di aplikasi tersebut.
2. Memulai pembuatan dokumentasi. Dalam pembuatan dokumentasi sebisa mungkin harus di mengerti dan di pahami oleh user atau client.
3. Update dari programmer. Update tersebut biasanya penambahan fungsi dari setiap modul yang ada di aplikasi tersebut yang kemudian nantinya akan diperbaharui oleh
software documentation.
10 Saran
Saran dari hasil penelitian yang diajukan oleh penulis demi mencapai hasil yang lebih baik adalah, pertama dalam proses pembuatan sebuah dokumentasi aplikasi seorang software
documentation harus mengetahui alur dari aplikasi tersebut agar mempermudah pada saat
membuat tahapan dokumentasi aplikasi. Kedua, tidak terjadi perubahan pada saat telah dibuatnya dokumentasi aplikasi, karena akan mempersulit penulis untuk memperbaharui dokumentasi tersebut. Penelitian selanjutnya diharapkan adanya alur proses yang pasti dari setiap pembangunan aplikasi khususnya dalam pembuatan dokumentasi aplikasi PIMS-TGI agar tidak adanya perubahan yang terjadi pada saat telah dibuatnya dokumentasi aplikasi tersebut.
Bibliography
Aram, A. N., & Atan, R. (2012). Traceability Method for Software Engineering Documentation. Journal of Computer Science Issues , 2-15.
Barker, T. T. (1992). Perspectives on Software Documentation: Inquiries and Innovations (Technical Communications Series). Technical Communication Quarterly , 78-82.
Bremer, M. (1955). The user manual manual : how to research, write, test, edit and produce a
software manual.
Briand, L. C. (2003). Software Documentation: How much is enough. In Proceedings of the
Seventh European Confrence on Software Maintenance and Reengineering , 13-17.
Briliakta, A., Agus, N., & Purwadi, J. (2012). Pembuatan Aplikasi Dokumentasi Jaringan.
Network Documentation , 1-11.
Clements, P. (2002). Documenting Software Architectures: Views and Beyond. Documenting
Software Architectures: Views and Beyond (2nd Edition) , 168.
Forward, A., & Lethbridge, T. C. (2002). The Relevence of Software Documentation, tools and Technologies : a Survey. 26-33.
http://www.techscribe.co.uk/ta/how-to-write-user-documentation.htm. (n.d.). Retrieved
December 21, 2012, from
http://www.techscribe.co.uk/ta/how-to-write-user-documentation.htm: http://www.techscribe.co.uk/ta/how-to-write-user-documentation.htm Keyes, J. (1950). Software Engineering handbook. United States of America: CRC Press LLC.
11 Sommerville, I. (2001, November 07). http://www.literateprogramming.com. Retrieved
December 21, 2012, from http://www.literateprogramming.com: http://www.literateprogramming.com/documentation.pdf
