Teknik Dokumentasi Aplikasi

Software Crisis
pertemuan 1

nama dosen : Bu tyas

software krisis bisa terjadi karena ketidakmampuan project yang diinginkan

misalnya :

• kebanyakan uang
• terlalu bayak waktu
• softwarenya jelek dan tidak efisien

Dokumentasi meliputi :

• Perencanaan ==> ketika fase perencanaan
• Requirements analis
• IRS ==> Interface Requirement Spesification
• Dokumentasi perancangan
• Dokumentasi pengujian
• Dokumentasi yang berhubungan dengan produk
• Dan dokumen lainya

Doxygen adalah sofware pendukung perangkat lunak untuk memberikan dokumentasi pada kode-kode komentar source code

Tujuan SOW (Statement of work)

• menjelaskan biaya dan jadwal serta asumsi utama dalam proyek
• menjelaskan peranan dan tanggung jawab
• mengukuhkan definisi hal yang akan dicapai dalam proyek
• mendorong diselesaikanya proyek

yang diperlukan oleh dokumentasi adalah :

• Pendefinisian
• Perencanaan
• Organisasi
• Pengawasan

nama : Rika Nur Rahman
Nim : 09390100001

pertemuan 2

Investigasi

nama dosen : Bu tyas

Tahap Penyelidikan

     ada dua tahap investigasi dalam proses menulis. tujuan awal untuk mengembangkan ide-ide tentang persyaratan dokumentasi. tahap penyelidikan kedua adalah di mana Anda harus pergi ke subjek secara lebih mendalam dan muncul dengan rincian yang memadai untuk menulis buku. tergantung pada sistem dan situasi Anda, Anda sudah mungkin telah melakukan banyak penelitian ini pada tahap awal, akan tetapi anda tidak diragukan lagi, akan daerah di mana Anda merasa kurang nyaman tentang informasi yang diperoleh sebelumnya. Jadi bagaimana  Anda benar-benar tahu tentang topik atau penonton? untuk mulai bekerja dengan sedikit pengetahuan . kita akan mulai dengan melihat bahwa audiens daerah-Anda yang paling penting.
  
Tahap Mempertimbangkan Audien
     bahkan produk atau layanan yang tidak dikemas mungkin sesuatu yang kompromi kepada anggota keluarga yang banyak menggunakannya. suatu tempat di sepanjang garis selama proses desain, keputusan sewenang-wenang akan telah dibuat dan tujuan komersial akan mengambil yang diutamakan adalah kebutuhan individu. untuk menjaga keseimbangan, kita tidak harus mengabaikan fakta bahwa, hanya sesekali, pengguna permintaan bisa sangat rewel!

Tahap menentukan panjang optimal dari buku
     buku pendek lebih mungkin dibaca daripada yang panjang. benar juga untuk mengatakan bahwa kemarahan yang benar pada bagian dari penulis atau manajemen lebih dibenarkan atas sebuah buku yang belum dibaca dari 5.000 kata - katakanlah 30 halaman, dari 80.000 kata atau 480 halaman. yang lebih penting, buku pendek tidak akan hanya dibaca, akan dipahami-memberikan tentu saja bahwa itu ditulis dengan baik.

Tahap melihat sistem 

      penulis harus membutuhan dan menangani sistem dari dua sudut. itu adalah kebutuhan untuk memeriksa tidak hanya 'mur dan baut' dari struktur sistem, opsi, dan fitur, tetapi juga aplikasi praktis dari setiap elemen.

sistem komputer untuk mencerminkan kegiatan seperti ini dapat mencakup modul berikut:

• pengendalian stok, termasuk ketentuan untuk back-order
•  memeriksa kredit pelanggan
•  pemrosesan order, termasuk antarmuka dengan kredit, saham pelanggan, dan kartu kredit modul
•  pengiriman perencanaan, termasuk rincian perkiraan kedatangan di tempat pelanggan
• persiapan pengepakan dan pengiriman dokumentasi

sumber : Low Roderick with Ford Harriet, Pallot John and Hall James.1994 Writing User Documentation, A Practical Guide for those who want to be read