Pemilihan Format Dokumentasi

oleh:candra adi putra [aptx49@akakom.org]

Abstract

Dokumen ini menjelaskan tentang macam macam format
dokumentasi yang umum dipakai para developer dan
perusahaan software untuk para penggunanya.Umumnya
dokumentasi ada di menu Help ->Help pada kebanyakan
aplikasi GUI di windows ataupun Linux.

Dokumentasi suatu produk adalah hal yang umumnya selalu
ada dalam setiap produk yang dijualm,apalagi kalau
produk tersebut adalah produk elektronik ataupun produk
IT.Dokumentasi umumnya berupa buku penunjuk tentang
cara menggunakan dan merawat produk tersebut beserta
troubleshooting untuk permasalahan umum yang paling
sering terjadi ataupun FAQ ataupun berupa e-book atau
dalam format digital.

Tidak jauh berbeda dengan dunia pengembangan
software,produk ini pun umumnya memberikan dokumentasi
lengkap tentang bagaimana cara
mengoperasikan,mengkonfigurasi dan dan menyelesaikan
masalah yang kerap terjadi.Biasanya juga disertakan
alamat website dan juga support lewat email dengan
format email umumnya atau support@productName.com.

Beragamnya format dokument ternyata juga mempengaruhi
format dokumentasi suatu software diantara format
format yang umum dipakai adalah PDF,CHM,Text,HTML dan doc.

PDF

format ini adalah format de facto didunia publikasi dan
dokumentasi suatu software.Kelebihan dari format ini
adalah independent platform,format tidak berubah
walaupun ditampilkan dengan viewer yang berbeda dan
kemampuan melakukan linking baik secara internal
(didalam dokumentasi itu sendiri) ataupun
external(keluar dokumentasi).Selain itu,format ini juga
bisa dibuat dengan berbagai macam tool baik yang free
maupun yang bayar.Yang lebih penting adalah keaslian
dokumen bisa dipertanggungjawabkan dimana PDF bisa
melakukan enkripsi dan signature pada dokument.

Kekeurangan format ini adalah ukuran file yang relatif
besar dan diperlukan viewer khusus untuk melihatnya.

CHM

Chm adalah kependekan dari compiled?Html.Format ini
adalah format buatan microsoft untuk menggantikan
format .hlp dimana format ini sudah usang.CHM
sebenarnya adalah file html yang dikompilasi sehingga
source code html tidak bisa dilihat lagi.Umumnnya Chm
dipakai pada dokumentasi atau manual aplikasi windows.

HTML

format ini adalah format yang paling banyak
digunakan.Dengan html, user hanya perlu membukanya
dengan browser.Untuk HTML sendiri kekurangannya adalah
file yang terpisah pisah sehingga integrasi dokumen kurang.

Text

format ini banyak digunakan pada software software yang
berjalan di mode text ataupun command line.Sebagian
besar program dilinux under konsole akan memakai file
text murni untuk melakukan dokumentasinya.Biasanya
digunakan untuk changelog,Readme,lisensi dan cara
menginstall suatu software.

Kelebihan dari format ini adalah bisa dibuka
disembarang text editor atau text viewer.Kekurangan
dari format ini adalah untuk membacanya hanya bisa
dilakukan secara berurutan dari atas
kebawah(sekuensial).Format dokumen ini tidak cocok
untuk pendokumentasian software besar.

Doc

format ini adalah format yang biasa dipakai
diwindows.Untuk membuka file ini kita perlu Ms Word
atau word prosesor yang mendukung doc format.Kelemahan
dari format ini adalah ketidakkonsistenan tampilan.Pada
wordprosesor yang berbeda maka tampilan akan
berbeda.misal karena font yang dipakai di dokument
tidak tersedia disystem.Lebih parahnya lagi jika file
ini dibuka pada Word prosesor lain seperti openoffice
maka file doc ini biasanya tertampil dengan berantakan.

Web

Selain format diatas,biasanya ada bebapa software yang
tidak menyertakan dokumentasi pada produknya malainkan
hanya shortcut ke website yang produk ini
didapat.Biasanya program program aplikasi internet akan
menggunakan cara yang satu ini.Opera dan Yahoo!
Messenger adalah contohnya.

Kelebihan dari format ini tentunya mengurangi space
hardisk dan ukuran master program.kelebihan lain adalah
user akan selalu mendapatkan dokument
terkini.kekurangan dari format ini adalah diperlukannya
koneksi internet,sehingga cara seperti ini tidak cocok
untuk sebagin besar aplikasi deskop yang bersifat standalone.

Dari Berbagai macam format diatas,tidak ada format yang
paling bagus ataupun paling ideal.Hal terpenting dalam
pemilihan dokumen adalah disesuikan dengan panjang
dokumen,lingkungan aplikasi dan sasaran pengguna itu sendiri.

Komentar

Postingan populer dari blog ini

Cara Menurunkan Suhu Prosesor dan Motherboard

Cara Mereset Handphone Nokia N70

Cara Blokir Seseorang di Facebook Page