Resume Kuliah Teknik Dokumentasi Aplikasi - Pertemuan 4

DEFINING THE NEED FOR INFORMATION

Cara paling efektif untuk membangun publikasi yang baik tentu membutuhkan analisis

WRITING THE FIRST DRAFT

- Aturan (Rules):

·         Selalu menjaga hubungan dengan editor 

·         Tinjau secara terus menerus

·         Belajar dari kesalahan

- Bab (Chapter)

• Bagian informasi utama dalam buku
• Memudahkan pembaca mengenai apa yang mereka cari
• Materi apa saja yang terkait
• Bagian dari bab yang yang digunakan untuk memecah bagian menjadi beberapa yang lebih mudah dimengerti
• Bagian harus mencakup satu kegiatan

- Paragraf

Paragraf adalah suatu bagian dari bab pada sebuah karangan atau karya ilmiah yang mana cara penulisannya harus dimulai dengan baris baru. Paragraf dikenal juga dengan nama lain alinea. Paragraf dibuat dengan membuat kata pertama pada baris pertama masuk kedalam (geser ke sebelah kanan) beberapa ketukan atau spasi

~ Syarat sebuah paragraf

Di setiap paragraf harus memuat dua bagian penting, yaitu:

1. Kalimat pokok

Biasanya diletakkan pada awal paragraf, tatapi bisa juga diletakkan pada bagian tengah maupun akhir paragraf. Kalimat pokok adalah kalimat yang inti dari ide atau gagasan dari sebuah paragraf. Biasanya berisi suatu peryataan yang nantinya akan dijelaskan lebih lanjut oleh kalimat lainnya dalam bentuk kalimat penjelas.

      2. Kalimat Penjelas

Kalimat penjelas adalah kalimat yang memberikan penjelasan tambahan atau detil rincian dari kalimat pokok suatu paragraf.

~ Bagian-bagian suatu paragraf yang baik

a.      Terdapat ide atau gagasan yang menarik dan diperlukan untuk merangkai kesulurahan tulisan

b.      Kalimat yang satu dengan yang lain saling berkaitan dan berhubungan dengan wajar.

Sumber : link

Lampiran

Berisi tentang informasi yang berhubungan dengan buku

Contoh lampiran: link

Judul

• Judul adalah nama yang dipakai untuk buku, bab dalam buku, kepala berita, dan lain-lain; identitas atau cermin dari jiwa seluruh karya tulis, bersifat menjelaskan diri dan yang manarik perhatian dan adakalanya menentukan wilayah (lokasi). Dalam artikel judul sering disebut juga kepala tulisan.  

• Judul adalah lukisan singkat suatu artikel atau disebut juga miniatur isi bahasan. Judul hendaknya dibuat dengan ringkas, padat dan menarik. Judul artikel diusahakan tidak lebih dari lima kata, tetapi cukup menggambarkan isi bahasan.

~Syarat-syarat pembuatan judul:

·         1. Harus relevan, yaitu harus mempunyai pertalian dengan temanya, atau ada pertalian dengan beberapa bagian penting dari tema tersebut.

·         2. Harus provokatif, yaitu harus menarik dengan sedemikian rupa sehingga menimbulkan keinginan tahu dari tiap pembaca terhadap isi buku atau karangan. 

·         3. Harus singkat, yaitu tidak boleh mengambil bentuk kalimat atau frasa yang panjang, tetapi harus berbentuk kata atau rangklaian kata yang singkat. Usahakan judul tidak lebih dari lima kata. 

Sumber : link

Resume Kuliah Teknik Dokumentasi Aplikasi - Pertemuan 3

TIPE-TIPE BUKU

Kualitas teknik Dokumentasi

 Kualitas dalam teknik publikasi adalah relatif

-       Kualitas dalam teknik publikasi tergantung pada persepsi seorang pengguna (pembaca)

-       Kesesuaian dengan persyaratan (Crosby, 1979)

Syarat dari teknik publikasi dari sebuah buku

• Memberikan nilai/informasi yang baik.
• Informasi yang digunakan akurat
• Customer tidak banyak tanya
• Pengeluaran yang dikeluarkan dengan rendah :
• Memberikan batasan yang rendah terhadap orang yang tidak suka membaca
• Mengurangi biaya dukungan dari customer support
• Tidak banyak turun lapangan tetapi banyak memmbaca buku petunjuk
• Meningkatkan penjualan

6 langkah dalam proses menulis :

• Analisa pembaca : Mengetahui dan menganalisa siapa yang akan membaca buku kita sangatlah penting, hal ini dikarenakan agar buku yang telah dibuat tidak salah sasaran.
• Membuat ringkasan : Agar para pembaca mengetahui definisi awal atau ringkasan dari buku maka perlu ditambahkan untuk menarik minat para pembaca.
• Mebuat rincian : Setelah ringkasan dapat membuat tertarik para pembaca, tentu saja di dalam buku harus dibuatkan pendefinisian secara rinci mengenai materi yang dibawakan.
• Memilih gaya dan format yang akan digunakan : Gaya penulisan dan format penulisan perlu diperhatikan agar tidak membuat pembaca merasa bosan dengan isi buku dan juga agar pembaca tertarik untuk membaca buku.
• Menulis buku manual : Setelah semua bahan di atas dipersiapkan, maka sekarang waktunya untuk menulis bukunya berdasarkan konsep - konsep di atas.
• Mencoba buku manual : Jika buku sudah dibuat, proses selanjutnya melakukan percobaan kepada para pembaca.

4 macam buku manual aplikasi / software :

• Pengantar panduan : Berguna sebagai gambaran awal atau pengantar dari software / aplikasi yang dimaksud, mendeskripsikan fitur - fitur dari produk, dan menjelaskan keuntungan bila memakai produk tersebut. 

         - Contoh Introduction manual : Link Pengantar Panduan

• Panduan pelatihan : Untuk membantu pengguna apa yang harus mereka lakukan, menjelaskan bahwa apa yang mereka lakukan itu sudah benar, dan memberikan pengguna rasa percaya diri dalam menjalankan produk tersebut. 

          - Contoh training manual : Link training manual

• Panduan user : Untuk mengenalakan seluruh kemampuan dari sistem yang dibuat, mengetahui bagaimana caranya menggunakan produk ini seperti apa yang mereka inginkan, dan menunjukkan bagaimana mencapai hasil dengan menggunakan produk ini. 

          - Contoh user manual : Link user manual

• Panduan referensi : Memberikan pengetahuan lebih dari produk yang dibuat dan tambahan informasi jika pengguna ingin belajar lebih jauh dari produk ini dan hal apapun yang berhubungan dengan produk ini. 

         - Contoh reference manual : Link referensi manual

TDA

Resume TDA 2

Proses Dokumentasi

Bicara proses dokumentasi, dibenak pikiran  akan muncul suatu kata yang membicarakan tentang bagaimana / cara atau langkah mendokumentasikan suatu aplikasi. berikut indicator, fungsi serta tujuan dari proses dokumentasi:

·         Indikator dari proses dokumentasi adalah :

1 .      Ketepatan menjelaskan hubungan antara kebutuhan project dan system yang sedang dikembangkan

2.      Ketepatan menjelaskan langkah-langkah pembuatan dokumentasi aplikasi

·         Fungsi dari proses dokumentasi

Mencatat seluruh proses dari pembangunan sampai pemeliharaanproses muali dari perencanaan, penjadwalan sampai ke standarisasinya.

·         Tujuan dari proses dokumentasi

Bisa dilihat atau di manage agar jelas langkah-langkahnya

Ada 2 cara untuk memproses dokumentasi :

1.     Waterfall

Menurut arti bahasa waterfall yaitu air terjun yang mengalir dari atas ke bawah. Jadi metode waterfall adalah suatu proses dokumetasi sebuah aplikasi yang dikerjakan dari langkah awal sampai akhir dan dikerjakan secara urut. Jika sebelumnya belum selesai maka tidak akan bisa melanjutkan ke tahap berikutnya.  

“Menurut Pressman (2010), model waterfall adalah model klasik yang bersifat sistematis, berurutan dalam membangun software. Nama model ini sebenarnya adalah “Linear Sequential Model”. Model ini sering disebut dengan “classic life cycle” atau model waterfall. Model ini termasuk kedalam model generic pada rekayasa perangkat lunak dan pertama kali diperkenalkan oleh Winston Royce sekitar tahun 1970 sehingga sering dianggap kuno, tetapi merupakan model yang paling banyak dipakai didalam Software Engineering (SE)”.

Langkah-langkah yang harus dilakukan pada metodologi Waterfall adalah sebagai berikut:

·         Analisis kebutuhan perangkat lunak 

Analisa kebutuhan bisa dilakukan dengan cara observasi atau wawancara. Setelah itu selesai kemudian kebutuhan – kebutuhan dianalisa dan didefinisikan untuk membangun sebuah aplikasi.

·         Desain

Proses software design untuk mengubah kebutuhan-kebutuhan di atas menjadi representasi ke dalam bentuk "blueprint" software sebelum coding dimulai. Langkah ini meliputi membuat sisflow,dfd,erd serta user interface.

·         Coding

Tahap ini yaitu memberikan intruksi-intruksi fungsi ke dalam desain tersebut untuk dilajalankan oleh computer.

·         Testing

Setelah coding selesai maka aplikasi tersebut di uji coba apakah ada kesalahan –kesalahan ataupun error sebelum aplikasi ini di gunakan oleh user.

·         Maintenance

Pemeliharaan suatu aplikasi diperlukan, termasuk di dalamnya adalah pengembangan, karena apliaksi yang dibuat tidak selamanya hanya seperti itu ketika dijalankan mungkin saja masih ada error kecil yang tidak ditemukan sebelumnya atau ada penambahan fitur-fitur yang belum ada pada software tersebut.  Pengembangan diperlukan ketika adanya perubahan dari eksternal perusahaan seperti ketika ada pergantian sistem operasi, atau perangkat lainnya.

2.     Agile

Suatu proses dokumentasi dengan cepat tanpa urutan yang lebih menerima value dari pada proses. Inilah prinsip – prinsip model agile yang diambil dari http://ilmukuilmumu.wordpress.com/2009/12/25/agile-sofware-development/

·         Kepuasan klien adalah prioritas utama dengan menghasilkan produk lebih awal dan terus menerus

·         Menerima perubahan kebutuhan, sekalipun diakhir pengembangan

·         Penyerahan hasil/software dalam hitungan waktu dua minggi sampai dua bulan

·         Bagian bisnis dan pembangun kerja sama tiap hari selama proyek berlangsung

·         Membangun proyek dilingkungan orang-orang yang bermotivasi tinggi yang bekerja dalam lingkungan yang mendukung dan yang dipercaya untuk dapat menyelesaikan proyek.

·         Komunikasi dengan berhadapan langsung adalah komunikasi yang efektis dan efisien

·         Software yang berfungsi adalah ukuran utama dari kemajuan proyek

·         Dukungan yang stabil dari sponsor, pembangun, dan pengguna diperlukan untuk menjaga perkembangan yang berkesinambungan.

·         Perhatian kepada kehebatan teknis dan desain yang bagus meningkatkan sifat agile

·         Kesederhanaan penting

·         Arsitek. Kebutuhan dan desain yang bagus muncul dari tim yang mengatur dirinya sendiri

·         secara periodic tim evaluasi diri dan mencari cara untuk lebih efektif dan segera melakukannya.

Kelebihan dan kekurangan dari model Waterfall dan Agile

·         Kelebihan

Waterfall	Agile
Dapat diprediksi	Memenuhi kebutuhan customer karena lebih cepat
Semua kebutuhan sistem dapat didefinisikan secara utuh dan explisit	Kecilnya kerugian material dan inmaterial
cocok untuk software berskala besar dan yang bersifat umum.	Tidak membutuhkan waktu terlalu lama

·         Kelemahan

Waterfall	Agile
Ketika ada masalah diproses sebelumnya maka tidak bisa melanjutkan ke proses selanjutnya	Cara pengembangannya cukup sulit.
Harus menunggu dari proses sebelumnya	Harus memahami secara betul prosesnya

http://cisenaextreme99.blogspot.com/2013/06/metode-waterfall-menurut-pressman.html

http://cprlkllr.blogspot.com/2013/06/rpl-macam-macam-jenis-model-proses.html

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

Teknik Dokumentasi Aplikasi

Pertemuan 1 

Aplikasi
Adalah Suatu subkelas perangkat lunak komputer yang memanfaatkan kemampuan komputer langsung untuk  melakukan suatu tugas yang diinginkan pengguna. Biasanya dibandingkan dengan perangkat lunak sistem yang mengintegrasikan berbagai kemampuan komputer, tapi tidak  secara langsung menerapkan kemampuan tersebut untuk mengerjakan suatu tugas yang menguntungkan pengguna.


Dokumentasi
Adalah Segala sesuatu yang tertulis, bergambar dan terekam yang berisikan penjelasan mengenai suatu hal atau informasi dari suatu peristiwa yang digunakan untuk membantu ingatan dan/atau dapat dijadikan pedoman.

Pemakaian Teknik – teknik Sistem :

• Teknik-teknik sistem penting bagi auditor internal dan eksternal serta para personel sistem dalam pengembangan sistem informasi.
• Teknik-teknik sistem juga digunakan oleh akuntan yang melakukan pembuatan sistem, baik secara internal bagi perusahaannya maupun secara eksternal sebagai seorang konsultan.

Ada beberapa alasan mengapa sistem perlu didokumentasikan :

1. Untuk merancang atau membuat sebuah sistem. Dokumentasi sistem berguna sebagai media diskusi dan komunikasi antar perancang, analis, maupun programer. 
2. Selain itu, dokumentasi juga berguna untuk mengevaluasi kelemahan dan keunggulan sebuah sistem maupun pengendalian dalam sebuah sistem. Pihak yang berkepentingan dengan evaluasi sistem adalah (1) analis sistem (pada saat si analis sedang menegvaluasi sistem lama yang sudah berjalan) dan (2) auditor (baik auditor internal maupun auditor eksternal). Auditor laporan keuangan hanya dapat melakukan audit jika data laporan keuangan sebuah perusahaan dapat dipercaya (yang berarti dihasilkan dari sistem informasi akuntansi yang memang andal).
3. Dokumentasi sistem juga berguna bagi mereka ynng sedang mempelajari prosedur dalam sebuah perusahaan. Dokumentasi sistem dapat menjadi media pelatihan karyawan baru.

Tujuan Dokumentasi

1. Arus komunikasi

    Komunikasi terjadi dalam 3 arah:

      a. Ke bawah untuk melakukan instruksi

      b. Ke atas untuk memberi laporan

      c. Ke samping (lateral) untuk memberi saran

2. Untuk memberi informasi

     Pentingnya kiranya untuk terus-menerus memberi informasi kepada orang tentang apa yang          telah,sedang,dan akan dilakukan,serta segala perubahan dalam pekerjaan yang telah ditetapkan.

3. Untuk mengidentifikasi

     Beberapa dokumentasi dirancang untuk mengidentifikasi.

4. Untuk menetapkan Prosedur dan Standar

     Prosedur menentukan rangkaian kegiatan yang akan dilakasanakan,sedangkan Standar menentukan aturan yang akan dianut dalam menjalankan prosedur tersebut.

5. Untuk mencatat

     Dokumentasi akan diperlukan untuk memonitor kinerja perlatan,sistem,dan sumber daya manusia.Dari dokumentasi ini,manajemen dapat memutuskan atau menilai apakah departemen tersebut memenuhi atau mencapai tujuannya dalam skala waktu dan batasan sumber dayanya.Selain itu,manajemen dapat mengukur kualitas pekerjaan,yaitu apakah outputnya sesuai dengan spedifikasi dan standar yang telah ditetapkan.

6. Untuk memberi instruksi

    Dokumentasi yang baik akan membantu dalam pelatihan staf,apakah pelatihan untuk tujuan penanganan instalasi baru atau untuk tujuan promosi.

Sumber :

1. ymukhlis.staff.gunadarma.ac.id/Downloads/files/8254/Dokumentasi.pdf
2. http://siswaddi.wordpress.com/2010/10/14/teknik-dan-dokumentasi-sistem/
3. http://blogakuntansi.blogspot.com/2011/11/teknik-dokumentasi-sistem.html