Materi
Kursus Technical Writing One dari Google merumuskan dokumentasi yang baik sebagai pengetahuan dan keterampilan yang dibutuhkan pembaca untuk mengerjakan sebuah tugas, dikurangi pengetahuan dan keterampilan yang sudah mereka punya. Isi dokumen adalah selisih itu: hal yang dibutuhkan tetapi belum dimiliki. Hal yang sudah dikuasai pembaca tidak perlu diulang, dan hal yang tidak dibutuhkan untuk tugasnya tidak perlu ditulis.
Pembaca didefinisikan dengan dua hal. Pertama, peran: kasir, admin gudang, pengembang. Orang dengan peran yang sama berbagi pengetahuan dasar. Kedua, kedekatan dengan pengetahuan: dua pengembang dengan peran sama bisa berbeda jauh karena yang satu ikut membangun proyeknya dan yang lain baru bergabung. Waktu juga mengubah kedekatan; ilmu yang lama tidak dipakai memudar. Sesudah itu, tulis daftar tugas yang harus bisa dikerjakan pembaca setelah membaca dokumen.
| Contoh: panduan retur di aplikasi kasir Rekapin (karangan) | Isinya |
|---|---|
| Peran pembaca | Kasir toko |
| Kedekatan | Sudah memakai Rekapin untuk penjualan, belum pernah memproses retur |
| Daftar tugas | Mencari struk asal; mengembalikan dana; mencatat alasan retur |
| Tidak ditulis | Cara masuk ke aplikasi dan cara mencatat penjualan (sudah dikuasai) |
Untuk istilah yang mungkin asing, Technical Writing One memberi dua jalan: bila penjelasan yang baik sudah ada, tautkan; bila dokumenmu yang memperkenalkan istilah itu, definisikan. Bila istilah barunya banyak, kumpulkan definisinya dalam glosarium.
