Teknik Dokumentasi & Aplikasi

Nov 3, 2015   //   by lulut   //   Articles, Management  //  No Comments

Process Documentation

Dokumentasi proses  merupakan dokumen-yang  merekam proses pengembangan dan maintenance. Rencana-rencana, jadwal-jadwal, dokumen kualitas proses, standar organisasi dan standar proses merupakan dokumentasi proses.

Dokumentasi proses dibuat agar pengembangan suatu sistem/software dapat dimanajemen dengan baik. Dokumentasi produk digunakan setelah sistem/software selesai atau operasional tetapi juga dapat berguna bagi manajemen proses pengembangan sistem, dalam kasus perbaikan atau revisi suatu sistem/software.

Agar manajemen dapat efektif, dibutuhkan suatu kejelasan pada proses-proses yang akan dikelola. Karena software merupakan suatu hal yang non fisik dan proses pembuatan software juga merupakan tugas-tugas pemikiran yang tidak terlihat fisik, salah satu cara agar membuat jadi jelas adalah dengan menggunakan dokumentasi.

Ada beberapa kategori dokumentasi proses :

  1. Perencanaan, perkiraan dan penjadwalan. Merupakan dokumen yang dibuat oleh manajer yang digunakan untuk memprediksi dan mengontrol proses software.
  2. Laporan / Reports . Merupakan dokumen yang mencatat bagaimana sumber daya- sumber daya digunakan selama proses pengembangan.
  3. Standar. Dokumen – dokumen ini menentukan bagaimana seharusnya suatu proses diimplementasikan. Ada berbagai macam standar mulai dalam lingkup organisasi, nasional bahkan internasional.
  4. Lembar kerja/ working paper. Sering kali merupakan dokumen komunikasi teknis utama dalam suatu proyek. Mereka merekam ide-ide dan pikiran-pikiran para engineer 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.
  5. Memo dan surat/pesan elektronik. Dokumen yang merekam rincian komunikasi seharihari 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/software telah jadi, seperti jadwal / perencanaan pembuatan. Bagaimanapun juga tetap ada beberapa dokumentasi proses yang berguna apabila ada perubahan software yang diinginkan, seperti hasil testing dan lembar kerja yang mencatat alasan-alasan kenapa suatu desain dipilih dalam pembuatan suatu sistem.

Product Documentation

Dokumentasi produk  dokumentasi ini menggambarkan produk yang sedang dikembangkan. Dokumentasi sistem menjelaskan produk dari sudut pandang teknis dalam mengembangkan dan memelihara sistem. Dokumentasi user menyediakan penjelasan produk yang berorientasi pada user.

Dokumentasi produk berkenaan dengan gambaran suatu produk software/ sistem yang telah jadi. Tidak seperti dokumentasi proses, dokumentasi produk biasanya berguna untuk waktu yang lebih lama, selama produk tersebut masih digunakan. Dokumentasi produk melingkupi user documentation yang memberitahu pengguna bagaimana cara mengoperasikan produk software, dan system documentation yang utamanya diperuntukkan bagi teknisi maintenance.

Ada 2 kategori dalam pdokumentasi produk yaitu:

  1. User Documentation : Pengguna dari suatu software / sistem tidaklah dapat disamaratakan. Merupakan suatu hal yang penting untuk membedakan antara end-user dengan system administrator. End-user menggunakan software sebagai alat bantu untuk mengerjakan suatu tugas, menulis sebuah buku, mengelola keuangan, bahkan menerbangkan pesawat. Mereka ingin tahu seberapa software dapat memudahkan pekerjaan mereka tetapi tidak ingin tahu detail teknis tentang software tersebut.
  2. System administrator : bertanggung jawab mengelola dan memelihara software yang digunakan oleh end-user. Dapat berupa operator, network manager, hingga master teknis yang memecahkan segala permasalahan end-user berkaitan dengan software, atau juga penghubung antara user dengan software developer.

Untuk memenuhi kebutuhan berbagai macam user beserta keahliannya yang masing-masing berbeda, paling tidak ada 5 macam dokumen yang harus diikutsertakan dalam penyerahan suatu produk software/sistem :

  1. Functional description of software/system :Secara singkat menggambarkan kebutuhan sistem untuk menjalankan program,Servis-servis yang dimiliki (fitur2) aplikasi,Gambaran umum dr aplikasi (abstraksi) ,User dapat menentukan apakah aplikasi benar-benar dibutuhkan hanya dengan,membaca functional description dan introductory manual.
  2. The system installation document: Diperuntukan bagi system administrator, Menyediakan informasi mendetail bagaimana cara menginstall system di lingkungan,system 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, Cara memulai system/aplikasi, Cara mengkonfigurasi aplikasi agar berjalan dengan system yang telah ada , Adanya installer otomatis untuk aplikasi-aplikasi sekarang membuat para pembuat S/W memandang tidak perlu adanya dokumen ini, padahal pada kenyataannyadokumen instalasi ini masih dibutuhkan agar para System manager dapat menemukan dan memecahkan sumber masalah jika ada problem pada waktu instalasi.
  3.  The introductory manual :Menyediakan pengenalan tentang system/aplikasi yang menggambarkan fungsi/penggunaan umum dari system/aplikasi tersebut, Menjelaskan cara memulai menggunakan program Menjelaskan bagaimana para user dapat menggunakan fungsi-fungsi umum yang dimiliki aplikasi disertai ilustrasi dan contoh bebas, Mencantumkan kesalahan-kesalahan yang umum/sering dilakukan oleh user dan cara menyelesaikannya.
  4. The system reference manual : Menjelaskan semua kegunaan dan fungsi yang dimiliki system/aplikasi, 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 system/aplikasi.
  5. System administrator guide :  Installation + system reference manual

System Documentation

System Documentation mencakup semua gambaran sistem itu sendiri mulai dari spesifikasi kebutuhan hingga hasil pengetesan yang dapat diterima (final acceptance test plan). Dokumen – dokumen yang menggambarkan bagaimana desain, implementasi dan pengetesan suatu sistem merupakan dokumen penting untuk bisa memahami dan memaintain software tersebut. Untuk suatu sistem besar yang dikembangkan dalam rangka memenuhi spesifikasi kebutuhan dari pelanggan, sistem documentation harus mencakup :

  1. Dokumen yang mencatat kebutuhan pelanggan dan alasan-alasannya.
  2. Dokumen yang menggambarkan arsitektur dari sistem
  3. Untuk setiap program yang ada pada sistem, gambaran arsitektur dari program tersebut.
  4. Untuk setiap komponen sistem, gambaran dari fungsionalitas / kegunaan dan interfaceinterfacenya.
  5. Listing kode program. Harus disertai komentar-komentar yang dapat menjelaskan bagian-bagian program yang kompleks beserta alasan penggunaan metode pengkodean tersebut. Apabila penamaan yang baik dan struktur pemrograman yang baik telah digunakan, listing kode tersebut akan lebih mudah dipahami tanpa memerlukan komentar tambahan.
  6. Dokumen validasi. Menjelaskan bagaimana setiap program divalidasi dan kaitannya dengan spesifikasi kebutuhan yang diinginkan oleh pelanggan.
  7. Panduan sistem maintenance, yang menjelaskan permasalahan-permasalahan yang telah diketahui dapat terjadi pada sistem

Referensi

http://blog.stikom.edu/tyas/

http://firmanalex.blogspot.com/2013/09/teknik-dokumentasi-aplikasi-pertemuan-1.html

Leave a comment