Style / Gaya Penulisan Dokumentasi Aplikasi
- Menggunakan tipe kalimat yang benar beserta struktur nya
- Kalimat Aktif, Contoh: "Program akan berjalan ketika anda menekan tombol 'ENTER'"
- Kalimat Pasif, Contoh: "Ketika Anda menekan tombol ENTER, maka program akan dijalankan"
2. Dalam penulisan dokumentasi harus Jelas, akurat, singkat.
3. Gunakan bahasa Inggris umum dalam penulisan dokumentasi <Bila Perlu>
4. Panjang Kalimat
- Mudah dipahami.
- Menggunakan kalimat yang simpel.
- Usahakan 1 kalimat mempunyai 13 - 21 kata.
- Hindarkan dari kata yang tak perlu.
5. Penomeran / Pengurutan
- Nomor berupa teks.
- Bab, Sub-Bab, Halaman, dan nomor
- Desimal
- Angka unit.
- Tanggal
- Jam.
- Nomor telepon.
6. Penekanan Kata / Kalimat.
- Tulisan tebal
- Tulisan miring
- Tulisan garis bawah.
7. Huruf Kapital
- Seluruhnya Kapital
- Seluruhnya Non-Kapital
- Huruf awal kata Kapital
0 komentar:
Posting Komentar