Dokumentasi

Dokumentasi
• Dokumentasi digunakan secara berkala untuk menggambarkan seluruh instruksi, program-program, dan naratif atau segala sesuatu yang bersifat abstrak/virtual mengenai sistem informasi.
• Dokumentasi mempunyai beberapa kegunaan, diantaranya :
o Selama dilaksanakan desain sistem merupakan penyusunan produk yang dibangun oleh team desain dan user.
o Setelah instalasi, merupakan dasar untuk membuat perubahan terhadap sistem.
o Kualitas dari dokumentasi menentukan seberapa besar flesibilitas departemen layanan informasi
memberikan respon terhadap permintaan user.
o Dokumentasi yang baik disajikan untuk mengurangi konflik antar user dengan departemen layanan
informasi, ketika sistem didokumentasikan dengan baik menjadi lebih mudah dimengerti oleh user.
• Melalui dokumentasi berarti referensi yang memadai tersedian ketika masalah terjadi, dan informasiinformasi ini membantu user untuk mempelajari bagaimana menyelesaikan masalah mereka dengan sistem.
• Terdapat beberapa jenis dokumentasi, yaitu :
o Dokumentasi desain
o Dokumentasi user untuk training
o Dokumentasi operasi
o Dokumentasi referensi user
Design Documentation
Purpose :
• Dokumentasi ini membantu komunikasi didalam tim desain, merepresentasikan konseptualisasi terakhir dari sistem yang baru atau pemahaman terhadap sistem yang telah ada.
• Selama proses desain kegunaan lain dari dokumentasi ini merupakan kontrol, menyediakan record dari apa yang telah dibangun dan diubah.
• Menjadi sangat penting untuk memastikan bahwa seluruh bagian dari sistem dipengaruhi oleh perubahan yang dipertimbangkan dan bahwa tanggung jawab untuk komponen-komponen dari sistem yang dipengaruhi oleh perubahan telah diberitahukan.
• Misalkan jika format file atau isi dari file diubah, maka modul program apa dan siapa saja pemrogram yang akan terpengaruh ?
• Kontrol ini juga berfungsi untuk memanggil ujicoba pelaksanaan yang lampau atau versi lama dari suatu program atau file.
• Jenis dokumentasi ini akan membentuk database yang baik untuk menentukan estimasi diwaktu mendatang mengenai berapa lama waktu yang dibutuhkan untuk membangun sistem yang serupa.
• Sistem perpustakaan program dapat menyimpan setiap track dari seluruh versi program dan memastikan bahwa pemrogram bekerja dengan versi terbaru.
Content :
• Komponen dari dokumentasi desain
o Tabel isian (secara hirarki)
o Survey
o Studi kemungkinan
o Dokumentasi sistem yang ada
o Spesifikasi untuk sistem baru
 Output
 Input
 Versi file
 Spesifikasi logika
 Modul program hirarki
 program aktual (seluruh versi)
• Outline program (mis :pseudocode)
• Referensi silang untuk variabel-variabel
• Modul-modul (secara hirarki)
• Referensi silang interface modul
• Pustaka identifier variabel
 Ujicoba
• Desain
• Data
• Pelaksanaan dan hasil
o Prosedur manual
 Diagram alur secara hirarki
 Naratif
 Kontrol kesalahan
o Rencana pekerjaan
o Laporan kemajuan
• Elemen mendasar dari dokumentasi desain seperti tersebut diatas, dokumentasi yang terpenting adalah tabel isian (table of content) yang disediakan sebagai derektori untuk file manual yang berisikan seluruh informasi lainnya mengenai sistem.
• Pustaka harus berisi survey dan studi kemungkinan dan dokumen yang berhubungan dengan analisis dari sistem yang ada. Juga sebagai tempat untuk menyimpan spesifikasi untuk sistem yang baru.
• Ketika diagram alur data diubah, maka diagram yang asli disimpan dalam penyimpanan arsip sebagai backup. Menyimpan dokumen terbaru dalam pustaka kerja dengan setiap modul tertanggal dan pointer untuk lokasi versi lampau dalam arsip.
• Penting untuk menyimpan salinan dari input, output dan format record file dan daftar modul. Baebagai macam modul dan file harus direferensi silang berdasarkan modul lain yang terkait dengannya.
• Harus terdapat daftar referensi silang dari pemanggilan modul dan modul yang menggunakan elemen data yang berbeda, dan jika diperlukan perubahan uratan pemanggilan atau format record, maka beberapa pemrogram yang terpengaruh dapat di beritahukan dengan menggunakan daftar referensi silang.
• Seseorang dalam tim desain harus ditunjuk sebagai pustakawan atau databese administrator, yang harus mendistribusikan daftar identifier kepada pemrogram.
User Documentation for training
Purpose :
• Dokumentasi training mempersiapkan user untuk implementasi dan penggunaan sistem selanjutnya
• Dokumentasi user training digunakan untuk menjembatani jarak antara prosedur-prosedur lama, saat ini dan yang dibutuhkan/diminta untuk sistem baru
• Dokumen ini harus dibangun oleh anggota user dari tim desain dalam hubungannya dengan user lainnya dalam organisasi
Content :
• Minimal komponen dokumentasi training user :
o Penjelasan mengenai sistem
o Pohon menu
o Transaksi input
o Output
o File
o Prosedur-prosedur proses
o Kesalahan-kesalahan
o Pertimbangan transisi :
 Ujicoba
 Konversi
• Sangat baik untuk memulai pelatihan dengan terlebih dahulu memberikan penjelasan menyeluruh mengenai sistem dan apa masud/tujuan diselesaikannya pelatihan tersebut
• Untuk aplikasi interaktif, pengguna dapat mempelajari sistem lebih sering dengan melihat pohon menu
• Pelatihan user juga termasuk mempertimbangkan pengaruh dari transisi, khususnya ujicoba dan konversi
Operation Documentation
Purpose :
• Bagian operasi dari departemen layanan informasi harus mengoperasikan sistem setelah
diimplementasikan
• Kelompok ini memerlukan informasi mengenai prosedur operasi normal dan bagaimana merespon kesalahan
• Informasi ini baiknya disiapkan oleh analis sistem dan programer, dan banyak diantaranya dihasilkan/diambil dari dokumentasi desain
Content :
• Minimal komponen dokumentasi operasi :
o Diagram alur sistem (identifikasi program dan urutan eksekusinya)
o Daftar program-program yang akan dijalankan dalam suatu perintah
o Untuk setiap program terdapat :
 Input yang dibutuhkan
 File yang dibutuhkan
 Naratif pemrosesan
 Output yang dihasilkan
 Kondisi kesalahan, pesan-pesan dan respon operator
 Komponen mesin/alat yang digunakan
 Kebutuhan/syarat-syarat setup
o Pendistribusian dan pemrosesan output yang dicetak
o Programer pemelihara yang bertanggungjawab mengenai sistem
o Tanggungjawab pengguna
o Terminal yang terhubung
• Diagram alur yang lengkap yang menunjukan input yang dibutuhkan untuk setiap program, file-file apa saja yang diperlukan dan output apa saja yang harus dicetak/dihasilkan
• Jika terdapat input yang khusus, maka harus diberikan catatan dan dokumentasi harus menunjukkan file-file yang terkait dalam pemrosesan
• Penting bagi operator untuk mengetahui kondisi kesalahan yang mungkin terjadi dan bagaimana merespon keadaan tersebut
• Jika terdapat beberapa pengguna sistem, maka akan menjadi hal yang baik jika disediakan daftar terminal dan pengguna yang mengakses sistem
User Reference Documentation
Purpose :
• Informasi ini akan dituju oleh user yang mempunyai pertanyan atau masalah sebelum mereka menghubungi departemen layanan informasi
• Jika dokumentasi ini memiliki kualitas yang cukup, maka pertanyaan-pertanyaan tersebut akan terjawab
tanpa harus menghubungi departemen layanan informasi
• Akan terjadi tingkat frustasi yang cukup tinggi ketika terjadi suatu kesalahan dengan sistem informasi dan user tidak mengerti mengapa terjadi masalah tersebut atau bagaimana cara mengatasinya
Content :
• Kebanyakan materi untuk dokumentasi ini dapat diambil dari dokumentasi lain
• Komponen minimal untuk dokumentasi referensi pengguna :
o Tabel isi
o Dokumen input
o Laporan output (cetak atau layar)
o Logika pemrosesan
o Kondisi kesalahan
o Prosedur manual
o Program dan staf pemelihara
o representatif pengguna
• Dokumen ini harus dibuat menjadi referensi manual seperti looseleaf binder yang dapat diperbaharui dengan mudah ketika sistem berkembangkan dan berubah suatu waktu
• Tabel terperinci dari isi dokumentasi diperlukan untuk membuat dokumentasi ini mudah digunakan sebagai referensi
• Penjabaran detail mengenai input, output dan logika pemrosesan juga harus tersedia
• Daftar kondisi kesalahan dan perbaikannya, akan sangat membantu menyertakan nama dari user yang berpengalaman dan programer pemelihara yang saat itu terkait dengan sistem tersebut .