Oleh: pembelajarselalu | Oktober 6, 2013

TDA Pert 3,4,&5

Dokumentasi Produk

  • Product documentation ini menjelaskan tentang hasil dari produk.
  • Menjelaskan tipe-tipe dokumen dan cara pemilihan tipe dokumentasi tang tepat sesuai dengan kebutuhan dokumentasi.

Terdapat dua kategori  dokumentasi produk :

1.       User Documentation : menjelaskan kepada use bagaimana cara menggunakan software produk tersebut.

  • 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.

2.       System Documentation : diutamakan untuk maintenance engineers. 

System Documentation mencakup semua gambaran sistem itu sendiri mulai dari spesifikasi kebutuhan hingga hasil pengetesan yang dapat diterima (final acceptance test plan). Dokumen – dokumen yang menggambarkan bagaimana desain, implementasi dan pengetesan suatu sistem merupakan dokumen penting untuk bisa memahami dan memaintain software tersebut. Untuk suatu sistem besar yang dikembangkan dalam rangka memenuhi spesifikasi kebutuhan dari pelanggan, sistem documentation harus mencakup :

  1. Dokumen yang mencatat kebutuhan pelanggan dan alasan-alasannya.
  2. Dokumen yang menggambarkan arsitektur dari sistem
  3. Untuk setiap program yang ada pada sistem, gambaran arsitektur dari program tersebut.
  4. Untuk setiap komponen sistem, gambaran dari fungsionalitas / kegunaan dan interfaceinterfacenya.
  5. 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.
  6. Dokumen validasi. Menjelaskan bagaimana setiap program divalidasi dan kaitannya dengan spesifikasi kebutuhan yang diinginkan oleh pelanggan.
  7. Panduan sistem maintenance, yang menjelaskan permasalahan-permasalahan yang telah diketahui dapat terjadi pada sistem.

Pengguna dari sistem itu tidak dapat disamaratakan maka harus dapat membuat dokumentasi yang memudahkan user,  dari level yang berbeda pengetahuan dan pengalamannya. Harus ada perbedaan cara pendokumentasian produk antara End User dan System Administration.

1. End User : menggunakan software sebagai alat bantu untuk mengerjakan suatu tugas, menulis sebuah buku, mengelola keuangan, bahkan menerbangkan pesawat. Mereka ingin tahu seberapa software dapat memudahkan pekerjaan mereka tetapi tidak ingin mengetahui detail teknis tentang software

2. System Administration : bertanggung jawab mengelola dan memelihara software yang digunakan oleh end user. Dapat berupa operator, network manager, hingga master teknis yang emecahkan segala  permasalahan end user yang berkaitan dengan software, atu juga penghubung anatara user dengan software developer.

Tipe – Tipe User Documentation

1.      Functional description of software/system

  • Secara singkat menggambarkan kebutuhan sistem untuk menjalankan program
  • Servis-servis yang dimiliki (fitur2) aplikasi
  • Gambaran umum dr aplikasi (abstraksi)

User dapat menentukan apakah aplikasi benar-benar dibutuhkan hanya dengan
membaca functional description dan introductory manual.

2.      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.

3.      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.

4.      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

5.      System administrator guide :

  • Installation + system reference manual.

Source :

http://bintarmadayraditya.files.wordpress.com/2012/02/dokumentasi-software.pdf

https://sites.google.com/site/kuliahtda/my-forms

Iklan

Tinggalkan Balasan

Isikan data di bawah atau klik salah satu ikon untuk log in:

Logo WordPress.com

You are commenting using your WordPress.com account. Logout / Ubah )

Gambar Twitter

You are commenting using your Twitter account. Logout / Ubah )

Foto Facebook

You are commenting using your Facebook account. Logout / Ubah )

Foto Google+

You are commenting using your Google+ account. Logout / Ubah )

Connecting to %s

Kategori

%d blogger menyukai ini: