Proses Dokumentasi (Berdasarkan Tipe-tipe Bukunya)
Proses Dokumentasi dibagi menjadi 5 kategori :
- Plans, estimates, and schedules, adalah dokumen yang diproduksi oleh manager yang digunakan untuk memperkirakan, memprediksi, mengontrol dan mengatur proses software.
- Report, adalah dokumen yang menginformasikan bagaimana sumber daya digunakan saat proses pengembangan.
- Standart, adalah dokumen yang menjelaskan bagaimana prose situ berjalan. Ex: Cobit, ISO, SWEEBOK dll.
- Working papers, merupakan bagian terpenting dari dokumen dalam sebuah proyek, karena mencatat ide-ide para pekerja, mencatat masalah yang ada dalam sebuah proyek dan secara tidak langsung working paper ini menjelaskan tentang design decission.
- Electronic mail messages, berisi detail percakapan antara manager dan pekerja. Ex : konsultasi lewat email. dll.
Karakteristik Proses Dokumentasi ::
- Dokumennya pasti akan kadaluarsa.
- Perencanaan biasanya dibuat mingguan, sehari sebelumnya atau bulanan.
- Proges report (semuanya tercatat).
- Software historians maksutnya proses ini tidak terlihat jelas kegunaanya biasanya tidak ada yang menyimpanya setelah software ini selesai.
- Untuk project internal kadang tidak bisa dibuat dokumentasinya dengan benar.
- Untuk project orang luar harus dibuat dengan benar dan sesuai dengan standart.
- Dokumentasi yang harus dibuat :
- Contract (dokumen apa saja yang diminta customer)
- Resiko-resiko yang terjadi pada saat contract berjalan. Ex : simpan catatan kecil atau email dll.
- Mungkin saja ada yang ingin mendapatkan sertifikasi.
Product Documentation (Berdasarkan Bentuk Bukunya)
Ada 2 kategori product dokumentasi ::
- User dokumentasi : Memberitahukan user cara menggunakan softwarenya.
- System dokumentasi : Menjelaskan bagaimana maintenance untuk enginernya.
User Dokumentasi
- Sebagai orang yang membuat dokumentasi harus bisa membuat dokumentasi yang memudahkan user baik dari level yang berbeda pengetahuannya dan pengalamannya.
- Harus dibedakan antara untuk end user atau untuk administrator.
- End user : bagaimana cara software itu membantu mereka, dan tidak membutuhkan administrator detail.
- System administrator : Bertanggung jawab untuk memanage atau mengelola software yang digunakan oleh end user.
- Functional description of software/system
- The system installation document
- The system reference manual
- System administrator guide
Functional description of softawre/system
- Menggambarkan kebutuhan sistem untuk menjalankan program
- Servis-servis yang dimiliki atau fitur-fitur aplikasi
- Gambaran umum dari aplikasi
- User dapat menentukan apakan aplikasi benar-benar dibutuhkan hanya dengan membaca functional description dan introductory manual.
The system installation document
- Diperuntukan bagi system administrator.
- Menyediakan informasi mendetail bagaimana cara menginstall system di lingkungan system yang spesifik.
- Mencantumkan gambaran file-file apa yang membentuk suatu sistem/aplikasi
- Persyaratan minimum dari hardware yang dibutuhkan.
- File-file(aplikasi) yang harus ada sebelum sistem diinstall
- Cara memulai system/aplikasi
- Cara mengkonfigurasi aplikasi agar berjalan dengan system yang telah ada \
- Adanya installer otomatis untuk aplikasi-aplikasi sekarang membuat para pembuat S/W memandang tidak perlu adanya dokumen ini, padahal pada kenyataannya dokumen instalasi ini masih dibutuhkan agar para System manager dapat menemukan dan memecahkan sumber masalah jika ada problem pada waktu instalasi.
The introductory manual
- Menyediakan pengenalan tentang system/aplikasi yang menggambarkan fungsi/penggunaan umum dari system/aplikasi tersebut.
- Menjelaskan cara memulai menggunakan program
- Menjelaskan bagaimana para user dapat menggunakan fungsi-fungsi umum yang dimiliki aplikasi disertai ilustrasi dan contoh bebas.
- Mencantumkan kesalahan-kesalahan yang umum/sering dilakukan oleh user dan cara menyelesaikannya.
The system reference manual
- Menjelaskan semua kegunaan dan fungsi yang dimiliki system/aplikasi
- Mencantumkan semua pesan kesalahan yang dimiliki sistem dan cara mengatasinya secara lengkap dan detail
- Penggunaan bahasa resmi dan teknik bisa digunakan
- Mencantumkan secara lengkap fitur dan cara operasional dari system/aplikasi
System administrator guide :
- Installation + system reference manual.
System Dokumentasi
- Mulai dari requirement - test
- System dokumentasi harus ada :
- Dokumen yang mencatat kebutuhan pelanggan dan alasan-alasannya.
- Dokumen yang menggambarkan arsitektur dari sistem
- Untuk setiap program yang ada pada sistem, gambaran arsitektur dari program tersebut.
- Untuk setiap komponen sistem, gambaran dari fungsionalitas / kegunaan dan interfaceinterfacenya.
- Listing kode program. Harus disertai komentar-komentar yang dapat menjelaskan bagian-bagian program yang kompleks beserta alasan penggunaan metode pengkodean tersebut. Apabila penamaan yang baik dan struktur pemrograman yang baik telah digunakan, listing kode tersebut akan lebih mudah dipahami tanpa memerlukan komentar tambahan.
- Dokumen validasi. Menjelaskan bagaimana setiap program divalidasi dan kaitannya dengan spesifikasi kebutuhan yang diinginkan oleh pelanggan.
- Panduan sistem maintenance, yang menjelaskan permasalahan-permasalahan yang telah diketahui dapat terjadi pada sistem.
Product Dokumentasi (Berdasarkan Usernya)
Alasan untuk membuat dokumentasi pengguna adalah sebagai berikut:
Untuk membantu para pengguna perangkat lunak Anda.
Untuk mengurangi biaya dukungan.
Untuk menggunakan sebagai alat pemasaran.
Untuk meningkatkan citra perusahaan
Audience Analisis
Perhatikan siapa yang akan menggunakan buku manual tersebut dan apa tugas (tugas) Yang dikerjakannya
Salah satu cara untuk mengkategorikan penonton adalah dengan peran pekerjaan.
data entry
Pengawas
Sistem administrator
Layanan Operator meja.
Metode pengelompokkan audience
- Cara tersebut bisa membantu kita dalam membuat dokumentasi yang benar-benar bisa digunakan
- Peran pekerjaan menunjukkan tingkat keahlian pengguna. Sebagai contoh, seorang administrator sistem biasanya seorang ahli dengan perangkat lunak, tetapi petugas entri data dapat berupa seorang ahli atau pemula.
Berbagai jenis pengguna melakukan tugas-tugas yang berbeda .
- Tugas adalah seperangkat operasi yang digunakan untuk mencapai suatu tujuan .
- Suatu prosedur adalah instruksi yang memberitahu seseorang bagaimana melakukan tugas tingkat rendah .
- Sebuah hirarki tugas ada, tingkat terendah yang merupakan serangkaian prosedur
