PROSES
DOCUMENTATION
Ø The Business Case
Kenapa sebuah perusahaan harus
membuat buku untuk user?
1. Buku
itu harus membantu user bagaimana menggunakan software.
2. Meminimalisasi
biaya maintenance.
3. Berisi/memuat
tentang nama perusahaan dan penulis
4. Dapat
mengangkat nama perusahaan tersebut.
Ø Writing User Documentation
1. Harus
tau, dokumentasi itu butuh apa saja. (id penulis, id user).
2. Harus
Tau benar subjeknya seperti apa, dan harus paham dengan apa yang dituliskan.
Ø Audience Analysis
(Siapa Orangnya?)
Siapa yang membaca/siapa yang akan
menggunakan buku itu dan tugas apa yang harus dikerjakan?
Contoh :
1. Data
Entry Clerk (Jenis Buku Introduction)
2. System
Administrator (Jenis Buku Reference)
3. Service
Desk Operator (Jenis Buku Reference dan
Functional)
Kenapa kita harus
mengetahui pekerjaan user terlebih dahulu?
1. Kita
dapat menetapkan dokumentasi bagi mereka dan benar-benar dpat dipakai
2. Tugasnya
apa saja, itu juga harus diketahui. Contoh : System Administrator
Ø Task Analysis
(Tugas)
1. Sekumpulan
operasi untuk mencapai suatu tujuan
2. Prosedur
3. Untuk
melihat apakah prosedur itu sesuai dengan orangnya :
-
Wawancara, Observasi
-
Mendapatkan informasi langsung dari
orang yang membuat
-
Mencocokkan tugasnya dan yang
dipraktekkan
4. Tuliskan
prosedurnya untuk tiap-tiap orang (jangan prosesnya).
Ø Determing the optimum length of the
books
Berapa banyak halaman yang harus
ada
1. Perhatikan
banyak halaman yang akan dituliskan
2. Orang
akan malas mencari-cari yang dia inginkan
3. Orang
ingin langsung dapat menemukan jawaban yang dicari
Ø Looking at the system
(lihat sistemnya)
1. Pahami
betul alur kerja sistem
2. Pembagian
dari sistem tuliskan dengan lengkap (reference)
Ø Starting the investigation
(menulis buku untuk siapa?)
1. Investigasi
mulai dari awal kerja sistem sampai akhir
2. Kesulitan
dan kemudahan sistem
3. Sebisa
mungkin dilihat dari sisi pengguna bukan dari pembuat sistem.
Ø Judul dan Tipe Buku
1. Judul
buku dengan jelas menyebutkan apa isi dari buku tersebut
2. Pastikan
semua kebutuhan dari user tertulis dalam buku tersebut.
Ø Avoiding the Pittalls
(Jangan membuat orang menjadi bingung dengan judul)
1. Jangan
membuat pembaca menjadi tambah bingung saat membaca dokumentasi
2. Penggunaan
kata-kata yang bias dipahami oleh orang awam, jangan sampai hanya penulis
sendiri yang paham.