Tenknik Dokumentasi Aplikasi Part III & IV

- Dokumentasi Proses Cont. . . . . -

• Proses  ini menghasilkan software artifact.

• Software artifact  ini digunakan selama pembangunan software dan perawatan software.

 Ada beberapa kategori dokumentasi proses : 1. Perencanaan, perkiraan dan penjadwalan. Merupakan dokumen yang dibuat oleh manajer yang digunakan untuk memprediksi dan mengontrol proses software. Setiap dokumen yang akan dibuat pasti terdapat definisi, scope dan reference 2. Laporan / Reports . Merupakan dokumen yang mencatat bagaimana sumber daya digunakan selama proses pengembangan. 3. Standar. Dokumen – dokumen ini menentukan bagaimana seharusnya suatu proses diimplementasikan. Ada berbagai macam standar mulai dalam lingkup organisasi, nasional bahkan internasional. Sumebr yang digunakan adalah sumber IEEE. 4. Lembar kerja/ working paper. Sering kali merupakan dokumen komunikasi teknis utama dalam suatu proyek. Mereka merekam ide-ide dan pikiran-pikiran para engineer yang bekerja dalam proyek, yang merupakan dokumentasi produk versi sementara yang menjelaskan strategi pengimplementasian dan penentuan masalah yang telah diidentifikasi. Seringkali dokumen ini mencatat alasan-alasan pemilihan suatu keputusan dalam desain. 5. Memo dan surat/pesan elektronik. Dokumen yang merekam rincian komunikasi sehari hari antara manajer dan development engineer.

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

  2. System Documentation : diutamakan untuk maintenance engineers. 

  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.

  Sumber : 

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

  Materi Kuliah TDA Stikom Surabaya

   

Teknik Dokumentasi Aplikasi Part II

- Dokumentasi Proses -

Suatu proses bisnis (dalam hal ini bisnis bukan hanya perdagangan saja, melainkan suatu proses pada pelaksanaan manajemen) penting untuk implementasi suatu program atau sistem. Pada suatu sistem informasi, menaikkan kualitas proses biasanya melibatkan elemen berikut ini :

• Metodologi
• Dokumentasi
• Standar

 Dokumentasi adalah suatu hal yang pertama-tama harus ditentukan dan diselesaikan. Hal ini penting agar dokumentasi dapat disusun dengan sukses adalah dilakukan dengan cara mengintegrasikan dokumentasi dengan metodologi, sehingga proses dokumentasi dilakukan ketika setiap langkah development dilakukan, daripada melakukannya setelah selesai.

Dokumentasi Proses (Software)
Dokumentasi proses dibuat agar pengembangan suatu sistem/software dapat di manajemen dengan baik. Agar manajemen dapat efektif, dibutuhkan suatu kejelasan pada proses-proses yang akan dikelola. karena software merupakan suatu hal yang non fisik dan proses pembuatan software juga merupakan tugas-tugas pemikiran yang tidak terlihat fisik, salah satu cara agar membuat jadi jelas adalah dengan menggunakan dokumentasi.

Ada beberapa kategori dokumentasi proses :
1. Perencanaan, perkiraan dan penjadwalan. Merupakan dokumen yang dibuat oleh
manajer yang digunakan untuk memprediksi dan mengontrol proses software.
2. Laporan / Reports . Merupakan dokumen yang mencatat bagaimana sumber dayasumber
daya digunakan selama proses pengembangan.
3. Standar. Dokumen – dokumen ini menentukan bagaimana seharusnya suatu proses
diimplementasikan. Ada berbagai macam standar mulai dalam lingkup organisasi,
nasional bahkan internasional.
4. Lembar kerja/ working paper. Sering kali merupakan dokumen komunikasi teknis utama
dalam suatu proyek. Mereka merekam ide-ide dan pikiran-pikiran para engineer yang
bekerja dalam proyek, yang merupakan dokumentasi produk versi sementara yang
menjelaskan strategi pengimplementasian dan penentuan masalah yang telah
diidentifikasi. Seringkali dokumen ini mencatat alasan-alasan pemilihan suatu
keputusan dalam desain.
5. Memo dan surat/pesan elektronik. Dokumen yang merekam rincian komunikasi sehari hari
antara manajer dan development engineer.

Software Development Life Cycle
 

Dua dasar, metodologi yang paling populer adalah :

• Pendekatan tradisional yaitu Metode Waterfall dan,
• Pendekatan Agile yang lebih baru.

Waterfall Model :
Waterfall model adalah pendekatan linier untuk mengembangkan perangkat lunak, yakni sebuah desain  proses yang sequensial (berurutan) yang dalam progressnya terlihat seperti aliran air ter-jun (waterfall) dari proses perancangan konsep, inisialisasi project, alanisis, desain, pembuatan system (coding), testing, produksi/implementasi dan perawatan (maintenance). Berikut adalah kelebihan dan kelemahan metode waterfall :

Kelebihan :
- Software yang dikembangkan dengan metode ini biasanya menghasilkan kualitas yang baik
- Dokumen pengembangan sistem sangat terorganiasir (sesuai dengan yang ada diurutan), karena setiap fase harus diselesaikan secara lengkap sebelum melangkah ke fase berikutnya.
- etiap langkah terpisah dan dapat diprediksi

Kekurangan :
- Membutuhkan keahlian yang baik atau yang telah berpengalaman dalam mengembangkan perangkat lunak, dalam arti metode ini kurang cocok bagi pemula.
- Diperlukan majaemen yang baik, karena proses pengembangan tidak dapat berulang sebelum menghasilkan suatu produk, yaitu aplikasi. Jadi apabila dalam suatu proses seperti perancangan tidak selesai tepat waktu, maka akan mempengaruhi keseluruhan proses pengembangan perangkat lunak.

- Iterasi sering terjadi menyebabkan masalah baru

- Client kesulitan untuk menyatakan semua ke inginannya secara eksplisit diawal tahap pengembangan

- Hasil software yang dikembangkan baru akan diketahui lama setelah proyek pengembangan dimulai

Agile Model :

Agile   software   development   (sering   disebut   ”agile”)adalah kumpulan dari metode-metode pengembangan perangkat  lunak  yang  berbasis  pada  Iterative  dan  Incremental  Model.    Agile  membawakan  perubahan  dari  model metode-metode  kelas  berat  seperti  waterfall  dan  Spiral.
Berikut adalah kelebihan dan kelemahan metode Agile :

Kelebihan :
- Proses Iterative dan Incremental,

- Requirement dapat berubah sewaktu-waktu,

- Pelacakan requirement dengan melihat Backlog produk,

- Keterlibatan user secara aktif,

- Rilis yang lebih cepat dan berkala, fungsi dirilis setiap akhir iterasi.

- Testing dilakukan setiap saat, Seperti metode-metode lainnya, Agile bukanlah metode yang  sempurna.

Kekurangan :

- Dokumentasi pada metode ini sangat minimal,

- Agile jarang dipraktekkan secara langsung,
- Interaksi dengan pelanggan yang berlebihan,
- Agile  sulit  diimplementasikan  dalam  proyek  yang berskala besar,
- Membutuhkan manajemen tim yang terlatih dan mempunyai ilmu yang sudah tinggi,
- Lemah dalam perencanaan arsitektur,
- Keterbatasan waktu dalam perencanaan proyek.

Untuk sekarang ini pada umumnya penggunaan kedua metode ini digabung untuk menghasilkan sistem sesuai dengan kebutuhan proyek dan kebutuhan user.


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

http://mohiqbal.staff.gunadarma.ac.id/

http://www.seguetech.com/blog/2013/07/05/waterfall-vs-agile-right-development-methodology

http://blog.unsri.ac.id/achekha/tugas-kuliah/keunggulan-dan-kelemahan-dari-beberapa-jenis-model-pengembangan-perangkat-lunak-rpl/mrdetail/1928

http://ciethiashifa.blogspot.com/2012/01/perbandingan-metodology-klasik-dan.html

materi kuliah -TDA- Stikom Surabaya

Teknik Dokumentasi Aplikasi Part 1

   

     1. Pengertian

     Dokumentasi

Meliputi bentuk naratif , bagan alir, diagram dan materi tertulis lainnya yang menjelaskan bagaimana sebuah sistem bekerja.  Dokumentasi tidak harus berupa dokumen tetapi juga deskripsi yang dapat menggambarkan tentang sesuatu hal agar dapat dimengerti.

    Aplikasi

                Adalah program siap pakai yang dibuat untuk melaksanakan suatu fungsi bagi pengguna/aplikasi yang lain dan dapat digunakan oleh sasaran yang dituju. Menurut Hendrayudi aplikasi adalah kumpulan perintah program yang dibuat untuk melakukan pekerjaan-pekerjaan tertentu.

   Teknik Dokumentasi Aplikasi
            Dokumen yang berisi segala hal catatan penting di coding /script pemrograman yang dipakai, bisa juga query yang digunakan. Namun biasanya seorang programmer yang baik akan menuliskan catatan/komentar pad coding yang dilakukannya. Hal ini berguna untuk mengingatkan kembali proses coding yang akan dilakukan, jika nantinya pelu untuk dibuka kembali (dimodifikasi/ditambah). Namun komentar yang banyak pada file tentu akan menambah ukuran file sehingga dipelukan sebuah dokumentasi teknis.

          2. Tujuan atau Pentingnya Dokumentasi Aplikasi / Program

a.       Petunjuk untuk mereka yang akan menggunakan program

b.      Sebagai bahasa trainaing didalam penerapan program

c.       Mempermudah pengembang sistem (developer) untuk memodifikasi/ mengembangkan program lebih lanjut

d.      Mempermudah mencari dan mengevaluasi kesalahan-kesalahn program yang terjadi

e.      Untuk back up program apabila program/aplikasi yang tersimpan di simpanan luar rusak, terhapus atau hilang

.         3.   Software Crisis (Permasalahan dalam pengembangan aplikasi )

Permasalahan yang ada dalam pengembangan aplikasi mencakup msalah teknis dan non teknis.

a.       Masalah Non Teknis

-          Aspek komunikasi kurang baik

-          Pengelolaan sumber daya tidak mencukupi (waktu, dana, manusia).

-          Manajemen resiko yang tidak terkendali hingga aspek kenyamanan bekerja.

b.      Masalah Teknis

-          Sistem kompleks makin banyak diusulkan dan klien makin membutuhkannya untuk kebutuhan bisnis

-          Terlalu banyak teknologi yang bisa dipilih, sebenarnya memudahkan tapi terkadang membuat bingung dalam memilihnya

-          Semakin banyak sistem yang yang terdistribusi dan erintegrasi

-          Inisialisasi kebutuhan yang kurang baik daei klien

-          Pengujian yang tidak mencukupi atau kurang detail

Source            : http://thrillerports.blogspot.com/2013/01/pengembangan-sistem-dan-teknik.html                                                 http://berbagi-ilmu-mifa309.blogspot.com/2012/05/pengertian-aplikasi.html  
                                http://hendyadityarisaldi.wordpress.com/category/teknik-dokumentasi-aplikasi/  
                        http://ci-muetz.blogspot.com/2010/05/membuat-dokumentasi-program.html 
                        http://laskar19.blogspot.com/2013/01/software-crisis.html