Teknik Dokumentasi Aplikasi -Chapter 5-

Product Documentation (Dokumentasi produk):

-Dapat menjelaskan kebutuhan dokumentasi aplikasi

Indikator:

-Menjelaskan pentingnya tahap investigasi terhadap user

-Menjelaskan macam-macam user

Business Case (Kasus bisnis):

Alasan membuat dokumentasi pengguna adalah sebagai berikut:

-Membantu menjalankan software

-Mengurangi biaya maintenance

-Menjadi alat pemasaran: logo perusahaan, nama brand

-Gambar perusahaan menjadi meningkatkan citra perusahaan

Sebelum Anda mulai membuat dokumentasi, mengidentifikasi alasan untuk membuat dokumentasi. Jika dokumentasinya tidak akan meningkatkan keuntungan, jangan membuat dokumentasi. Jangan membuat dokumentasi untuk menjelaskan produk yang rendah. Sebaliknya, ubahlah desain antarmuka-nya.

Investigasi: kunci untuk mendapatkan hasil yang bagus (menulis dokumentasi pengguna)

Tahapan investigasi dimana ide-ide itu dikembangkan. Jika sudah memilih subyek, harus mengetahui mendalam subyeknya.

Harus memperhatikan pelanggan: dikhususkan bagi siapa yang akan membaca buku panduanmu

Analisis audience: Dokumentasi tidak ada gunanya jika tidak menjawab pertanyaan-pertanyaan yang orang bertanya. Oleh karena itu, sebelum Anda mulai menulis, Anda perlu tahu tentang penonton dan tugas-tugas yang mereka lakukan

-Perhatikan siapa yang akan menggunakan buku manual tersebut dan apa tugas yang dikerjakannya.

Kategori audience dari sisi pekerjaan:

a. Data entry clerk: Petugas entri data, kadang-kadang disebut juru ketik, adalah anggota staf yang dipekerjakan untuk mengetik data ke database menggunakan keyboard, scanner optik, atau perekam data. keyboard sering digunakan dapat memiliki kunci spesialis dan beberapa warna untuk membantu dalam tugas dan mempercepat pekerjaan.

b. Supervisor : Suatu pimpinan dari suatu job desk karyawan

c. Sistem 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.

d. Service desk operator: adalah petugas operator pembantu servis pelanggan dimaksudkan untuk memberikan pelanggan atau pengguna akhir dengan menyediakan informasi dan dukungan terkait dengan perusahaan atau produk dan jasa lembaga.

Metode kategorisasi audience membantu untuk:

-Metode membantu membuat dokumentasi yang bisa diaplikasikan dari kebutuhan tipe pengguna

-Role pekerjaan menunjukkan tingkat kemahiran pengguna.

-Sistem administrator biasanya paling pintar dalam menguasai software tapi terkadang end-user bisa lebih pintar / amatir dari sistem administrator.

Analisis tugas: Berbagai jenis pengguna melakukan tugas-tugas yang berbeda. Tugas adalah seperangkat operasi yang digunakan untuk mencapai suatu tujuan. Suatu prosedur adalah daftar instruksi yang memberitahu seseorang bagaimana melakukan tugas tingkat rendah. Sebuah hirarki tugas ada tingkat terendah yang merupakan serangkaian prosedur.

Mungkin, pada tingkat yang lebih tinggi, lebih dari satu orang melakukan tugas.

-Perbedaan tugas dan prosedure

-Kumpulan dari operasi untuk mencapai tujuan

-Harus mengubah prosedur dari kumpulan instruksi untuk menjelaskan seseorang bagaimana mengerjakan tugas yang mudah

-Hirarki tugas yang ada yaitu level terbawah dari prosedur

Hal yang dilakukan untuk menemukan tugas dan prosedur yang dilakukan orang:

1. Mengetahui prosedur yang dibuat dari seseorang:

-Observasi mengenai pekerjaannya

-Mendapatkan informasi yang sudah ada dan membuat software

-Supaya mengetahui kenyataan yang sebenarnya

-Menulis satu / lebih prosedur untuk setiap orang

2. Menentukan panjang dari bukunya:

-Perhatikan banyak halaman yang akan dituliskan

-Orang akan malas mencari-cari jawaban yang diinginkan

-Orang ingin langsung dapat menemukan jawaban yang dicari

3. Melihat sistem:

-Pahami betul alur kerja sistem

-Pembagian dari sistem tuliskan dengan lengkap

4. Memulai investigasi:

-Investigasi mulai awal kerja sistem sampai dengan akhir kerja sistem

-Kesulitan dan kemudahan proses investigasi

-Sebisa mungkin dilihat dari sisi pengguna bukan pembuat sistem

5. Menentukan judul buku dan tipe buku:

-Judul buku dengan jelas menyebutkan apa isi dari buku tersebut

-Pastikan semua kebutuhan dari user tertulis dalam buku tersebut

6. Jangan membuat kebingungan:

-Jangan membuat pembaca menjadi tambah bingung saat membaca dokumentasi

-Pergunakan kata-kata yang bisa dipahami oleh orang awam, jangan hanya penulis sendiri yang paham

Sumber Pustaka:
Catatan Materi Kuliah TDA pert 5http://www.literateprogramming.com/documentation.pdf‎
http://www.techscribe.co.uk/ta/how-to-write-user-documentation.htm
Thanks to Google Translate

By: Azid Malil'ula Wildan M (10410110014)-S1 Komputerisasi Akuntansi