Resume Teknik Dokumentasi Aplikasi (Pertemuan 4)

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

:::... Menulis Draft Pertama ...:::

Peraturan 

1. Selalu menjaga hubungan dengan editor
2. Tinjau secara terus menerus
3. Belajar dari kesalahan

Dalam sebuah penulisan terdapat 10 aturan yang harus diperhatikan

1. Identifikasi target/pembaca : Dengan mengetahui taget pembaca, maka penulis akan lebih mudah membuat suatu tulisan.
2. Bicara dengan menggunakan bahasa pembaca : Dalam membuat suatu tulisan, penulis harus menggunakan bahasa yang umum digunakan oleh pembaca, sehingga tulisan yang dibuat dapat dimengerti oleh pembaca dari kalangan mana saja.
3. Hindari istilah-istilah yang susah dimengerti : Jangan menggunakan istilah-istilah yang sulit dimengerti oleh pembaca. Gunakan istilah yang mudah dipahami oleh kaum awam dan pemula, sehingga para pembaca tidak merasa binggung dengan istilah yang kita gunakan.
4. Hindari menggunakan kalimat panjang dan berbelit-belit : Kebanyakan pembaca tidak suka dengan kalimat yang terlalu panjang, karena kalimat yang panjang akan mengakibatkan para pembaca cepat merasa bosan dan kebingungan.
5. Gunakan kalimat singkat dan sederhana : Tidak perlu menggunakan kalimat yang berbelit-belit padahal maksudnya singkat.
6. langsung pada pokok pembahasan :Aturan ini sangat penting untuk meningkatkan konversi. Sering kali kita menginginkan pembaca melakukan sesuatu, kemudian memberikan cetita atau dorongan berupa keuntungan,tujuan dan manfaat dari apa yang kita minta terhadap pembaca.
7. Jelaskan pada pembaca tentang keuntungan bagi mereka : dengan cara mengutarakan keuntungan yang akan mereka dapatkan maka pembaca akan lebih tertarik untuk mambacanya.
8. berikan sentuhan kreatifitas pada tulisan
9. Review ulang tulisan : Untuk mengoreksi kesalahan agar penulisan kita akan menjadi lebih baik.
10. maksimalkan segala informasi : Akan lebih baik jika anda melakukan riset, mengumpulkan data secara maksimal dari buku, internet, ebook, forum apa yang anda sediakan benar-benar lengkap dan tidak salah.

Bab (Chapter)

• Bagian informasi utama dalam buku
• Memudahkan pembaca mengenai apa yang mereka cari
• Materi apa saja yang terkait

Bagian dan subbagian

• Bagian dari bab yang yang digunakan untuk memecah bagian menjadi beberapa yang lebih mudah dimengerti
• Bagian harus mencakup satu kegiatan

Paragraf

• Kumpulan dari kalimat - kalimat yang membentuk suatu ide utama
• Jangan menggunakan banyak paragraf kecil (beberapa kalimat saja)
• Jangan membagi paragraf pada halaman terpisah
• Selalu menempatkan line kosong (spasi) antar paragraf

Syarat sebuah paragraf

• Kalimat Pokok : Biasanya diletakkan pada awal paragraf, tetapi 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 pernyataan yang nantinya akan dijelaskan lebih lanjut oleh kalimat lainnya dalam bentuk kalimat penjelas.
• Kalimat Penjelas : Kalimat penjelas adalah kalimat yang memberikan penjelasan tambahan atau detail rincian dari kalimat pokok suatu paragraf.

Lampiran

• Menyediakan informasi yang berhubungan dengan buku
• Menggunakan standar dan struktur yang sama dengan bab

Judul (Headings)

• Digunakan pembaca untuk mendapat ide apa yang akan mereka dapatkan
• Hanya diperbolehkan 3 tingkatan (Bab, Bagian, dan Subbagian)
• Harus relevan dengan isinya
• Jangan menulis judul lebih dari satu baris 
• Selalu menempatkan beberapa tulisan antara judul bagian dengan subbagian pertama.
• Konsisten dalam pemilihan kata

Cautions : Untuk memperingatkan pembaca untuk setiap prosedur atau operasi yang dapat menyebabkan kerusakan peralatan atau kehilangan data.

Warnings : Dimana prosedur dapat menyebabkan cedera fisik.

Contoh (Example) : Memberikan pengguna suatu hal yang sama secara jelas.

Catatan (notes) : Menginformasikan pembaca informasi penting atau tambahan untuk subjek yang dijelaskan.