Resume Kuliah Teknik Dokumentasi Aplikasi - Pertemuan 5

Resume : Pertemuan 5

Materi Kuliah : Teknik Dokumentasi Aplikasi

Dosen : Ayuningtyas, S.Kom.,M.MT.,- MOS

Teknik Penulisan Dokumentasi Aplikasi

• Menggunakan pola kalimat yang tepat
• Menggunakan kalimat aktif 
• Menggunakan kalimat pasif

Kejelasan

•          Jelas
•          Akurat
•          Komunikasi yang singkat

Penggunaan Bahasa Inggris

• Menggunakan Bahasa Inggris yang umum dan mudah dimengerti
• Menggunakan empat macam kalimat (pernyataan, instruksi, pernyataan bersyarat, dan pertanyaan)

Panjang kalimat

•         Mudah dimengerti dan dipahami oleh pembaca
•        Gunakan kalimat pendek dan singkat
•        Gunakan antara 13 - 21 kata per-kalimat
•         Hilangkan/ hapus  kata yang tidak perlu

Penomoran

•       Nomor dalam teks
•       Bab, sub bab, halaman dan nomor bagian 
•       Angka desimal
•        Angka yang terkait dengan unit
•     Tanggal 
•        Waktu
•        Nomor telepon

Highlighting

•        Bold : untuk membuat tulisan menjadi cetak tebal
•        Italic : untuk membuat tulisan menjadi cetak miring
•        Underlining : untuk membuat tulisan menjadi bergaris bawah

Dokumentasi harus dipersiapkan untuk beberapa jenis pembaca,pengguna, operator dan programer.

1. Menulis Dokumentasi. Ketiak anda membeli paket perangkat lukan komersial seperti spreadsheet biasanya anda kana menemukan manual didalamnya. Itulah yang disebut dokumentasi  pengguna. Saat ini telah banyak dijumpai dalam bentuk CD perangkat lunak.
2. Menulis Dokumentasi Operator. Orang yang menjalankan komputer dalam jumlah yang banyak disebut operator komputer. Karena tidak semua dari meraka adlah programer, mereaka harus diberitahu apa yang harus dilakukan ketika program tidak berfungsi. Dokumentasi operator memberikan operasi tersebut.
3. Menulis Dokumentasi Programer. Lama sesudah tim pemogramn tidak bekerja lagi, program masih bisa digunakan. Jika ada 5 staf pemograman meninggalkan pekerjaan setiap tahun, setelah 5 tahun bisa jadi muncul tim programer yang benar-benar baru, yang tidak tahu apa-apa soal perangkt lunak yang sudah ada. Dokumentasi program membantu melatih pendatang baru dan membuat mereka bisa memelihara sistem.
4. Memelihara Program. Pemeliharaan meliputi semua aktivitas yang didesain untuk menjaga agar program tetap bekerja sesuai kondisi,bebas kesalahan dan pada tingkat yang terkini,penyesuaian, perbaikan,pengukuran, bebas kesalahan, dan sebagainya. Lebih jauh, pemeliharaan merupakan masalah penting dan harus ada dokumentasi untuk membantu programer membuat penyesuaian pada sistem yang ada.

Sumber : link