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

Teknik Dokumentasi Aplikasi -Chapter 4-

Product documentation

-Menjelaskan produk yang disampaikan dan harus berkembang dengan pengembangan produk perangkat lunak.

- Menjelaskan mengenai bentuk bukunya, bentuk bukunya berupa:

1. Buku panduan pengenalan

2. Buku panduan pelatihan

3. Buku panduan pengguna

4. Buku panduan referensi

5. Buku panduan struktur database, dsb.

- Ada hubungannya dengan cara menyampaikan produknya dan mempunyai umur panjang

- Ada kategori: user documentation, user manual

- Sistem dokumentasi: Semua prinsip dari proses dokumentasi. Menjelaskan bagaimana sistem bekerja, tetapi bukan cara mengoperasikannya.

Contoh: Persyaratan Spesifikasi, Desain Arsitektur, Rancangan rinci, Komentar Source Code, Termasuk keluaran seperti javadoc, Test Plan, Termasuk test case, V & V rencana dan hasil, Daftar bugs yang dikenal

- User dokumentasi: harus bisa membuat dokumentasi untuk memudahkan tugas dari user yang berbeda-beda dan dilihat dari pengalaman dan pengetahuan

- End-user: tidak membutuhkan proses pembuatan software tapi membutuhkan software tersebut untuk membantu tugasnya

- Sistem Administrator: bertanggjung jawab mengelola dan mengetahui permintaan dan pemetaan sistem software yang digunakan end-user.

Jenis-jenis dari user:

a. Manager & sistem evaluator

b. System administrator

c. Novice users

d. Experienced users

e. System Administrators

-Ada lima bidang penting yang harus didokumentasikan untuk rilis resmi dari aplikasi perangkat lunak. Ini tidak selalu masing-masing harus memiliki dokumen mereka sendiri, tetapi topik harus ditutup secara menyeluruh.

1. Deskripsi Fungsional perangkat lunak:

-Secara garis besar mengenai kebutuhan dan sedikit tentang servis yang disediakan

-Membutuhkan tentang penjelasan sistem

-User harus bisa membaca dokumen dan menentukan sistem yang akan dibutuhkan dan dibuat

2. Sistem/Instruksi instalasi: dibutuhkan oleh sistem administrator untuk menyediakan informasi mendetail bagaimana cara menginstall sistem di lingkungan sistem yang spesifik dan mencantumkan gambaran file-file apa yang membentuk suatu sistem/aplikasi

3. Introduction manual:

-Lebih ke penggunaan normalnya

-Menjelaskan bagaimana memulai software dan bagaimana pengguna menggunakan sistem fasilitas pada umumnya

4. Sistem referensi:

-Menjelaskan semua kegunaan dan fungsi yang dimiliki sistem/aplikasi

-Tersedia daftar error message-nya dan menjelaskan bagaimana memulihkan error

-Sistem harus komplit

-Teknik formal deskriptif seharusnya digunakan

5. Sistem dokumentasi: mencakup semua gambaran sistem itu sendiri mulai dari spesifikasi kebutuhan hingga hasil pengetesan yang dapat diterima termasuk dokumen requirement plan, yang harus ada:

a. Requirement: Kebutuhan pengguna dan perangkat lunak

b. Dokumentasi yang menjelaskan desain arsitektur

c. Deskripsi arsitektur

d. Deskripsi fungsional dan antarmuka

e. Source code, dengan penamaan yang standar yang dicetak harus sesuai fungsinya. Ex: source code dari transaksi

f. Dokumen validasi menjelaskan bagaimana setiap program berjalan.

Sumber Pustaka:
Catatan Materi Kuliah TDA pert 4
http://www.eecs.ucf.edu/~turgut/COURSES/EEL6883_SEII_Spr07/PaperPresentations/Sommerville-p143.ppt
http://www.literateprogramming.com/documentation.pdf‎
-Thanks to Google Translate-

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

Teknik Dokumentasi Aplikasi -Chapter 3-

Dokumentasi Proses

Kategori dokumen. Kebutuhan Dokumen:

A. Persyaratan umum semua dokumentasi perangkat lunak

· Harus menyediakan komunikasi antara anggota tim

· Harus bertindak sebagai penyimpanan informasi yang akan digunakan oleh teknisi pemeliharaan

· Harus menyediakan informasi yang cukup untuk manajemen untuk memungkinkan mereka untuk melakukan semua kegiatan pengelolaan program yang terkait

· Harus menjelaskan kepada pengguna bagaimana untuk mengoperasikan dan mengelola sistem

-Dalam semua proyek perangkat lunak beberapa jumlah dokumentasi harus dibuat sebelum kode yang ditulis. Ex: Rancangan dokumen, dll

-Dokumentasi harus dilanjutkan setelah kode telah selesai. Ex: Manual pengguna, dll

-Dua jenis utama dari dokumentasi dibuat adalah Proses dan Produk dokumen.

-Kualitas Dokumen: Menyediakan dokumentasi menyeluruh dan profesional adalah penting untuk setiap ukuran tim pengembangan produk. Masalahnya adalah bahwa banyak perangkat lunak profesional tidak memiliki keterampilan menulis untuk membuat dokumen tingkat profesional

Proses Dokumentasi:

-Proses dokumentasi akan menghasilkan software artifak. Software artifak yaitu segala sesuatu dari software (model/deskripsi) yang dikembangkan dan dipakai selama pengembangan dan pemeliharaan software.

- Contoh spesifikasi requirement, arsitektur, dan desain model. Dokumentasi ini dibuat untuk memungkinkan adanya keberhasilan pengelolaan produk perangkat lunak. Dibagi menjadi 5 kategori:

1. Perencanaan, estimasi, penjadwalan: diproduksi oleh para manajer yang digunakan untuk memproduksi dan mengontrol proses software-nya. Di buku lain disebutkan ada project management documents, perencanaan proyek, jadwal proyek, dan model laporan yang lain, ex: laporan rapat

2. Laporan: bagaimana sumberdaya digunakan selama proses pengembangan, seperti laporan project regular

3. Standar: Standar memainkan peran penting dalam pengembangan, pemeliharaan dan kegunaan dokumentasi. Standar dapat bertindak sebagai dasar untuk dokumentasinya berkualitas. Tetapi tidak cukup baik pada mereka sendiri. Biasanya menetapkan konten tingkat tinggi dan organisasi. contohnya seperti: CSC, IEEE / EIA 12207 0-1996, software life circle, IEEE / EIA 12207 1-1997, life circle data, IEEE / EIA 12207 2-1997, implementation consideration

4. Kertas kerja: seringkali dari teknik prinsip komunikasi dokumen dari proyek, seperti: coret-coretan kerja. Yang merekam ide dan pemikiran pekerjaan engineer dalam suatu pengerjaan proyek. Berupa detil desain yang berisi analisis dan metodologi desain, yang berupa workflow.

5. Komunikasi: merupakan detil komunikasi tiap hari antara manajer dan karyawan dari teknik pengembang.

Karakteristik:

-Memiliki umur yang relatif pendek

-Hanya penting untuk proses pengembangan internal. Kecuali dalam kasus di mana pelanggan membutuhkan pandangan ke data.

-Beberapa item, seperti kertas yang menggambarkan keputusan desain harus digali dan dipindahkan ke dalam kategori dokumentasi produk ketika mereka menjadi diimplementasikan

-Karakteristik yang umum dari dokumentasi adalah pasti akan kadaluarsa .

-Perencanaan biasanya dibuat secara mingguan / bulanan. Laporan progress-nya juga dilaporkan

-Software historian sedikit sekali penggunaannya yang kadaluarsa dan tidak bisa membuat, menyimpan setelah sistem dihasilkan

-Untuk proyek internal, untuk mengurangi jumlah proses dokumentasi. untuk orang luar, harus dibuatkan dokumentasi yang benar yaitu kontrak antara pelanggan dan pemasok, yang berisi dokumentasi apa saja yang dihasilkan.

- Tim pengembang juga membutuhkan evidence (catatan kecil) sebagai bukti pembuatan software. Dan the regulatory requirements yaitu proses mendapatkan sertifikasi.

Sumber Pustaka:

Catatan Materi Kuliah TDA pert 3

http://www.eecs.ucf.edu/~turgut/COURSES/EEL6883_SEII_Spr07/PaperPresentations/Sommerville-p143.ppt

http://www.literateprogramming.com/documentation.pdf‎

-Thanks to Google Translate -

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