Banyak tim pernah membuat dokumentasi dengan semangat besar di awal. Folder dibuat rapi, halaman ditulis banyak, lalu beberapa bulan kemudian orang tetap bertanya hal yang sama di grup. Masalahnya bukan karena dokumentasi tidak ada, tetapi karena dokumentasi itu tidak terasa dekat dengan kebutuhan pengguna.
Knowledge base yang baik bukan gudang file. Ia harus menjadi tempat orang kembali ketika bingung. Untuk sampai ke sana, tulisan perlu dimulai dari masalah yang sering muncul, bukan dari struktur internal tim.
Saya lebih percaya dokumentasi yang lahir dari pertanyaan nyata. Misalnya: bagaimana cara masuk akun, bagaimana mengubah data, bagaimana mengunggah file, atau apa yang harus dilakukan ketika pembayaran belum terbaca. Pertanyaan seperti ini mungkin sederhana, tetapi justru paling sering menyelamatkan waktu.
Kalau artikel ditulis memakai bahasa internal, pembaca sering tidak menemukan jawabannya. Gunakan kata yang biasa dipakai pengguna, bukan istilah yang hanya dipahami pengelola sistem.
Artikel bantuan tidak harus panjang. Yang penting pembaca tahu langkah pertama, syarat yang perlu disiapkan, dan apa tanda prosesnya berhasil. Setelah itu baru tambahkan contoh jika perlu.
Contoh kecil sering lebih membantu daripada penjelasan teoretis. Satu tangkapan layar, satu kalimat peringatan, atau satu contoh format data bisa membuat pengguna berhenti menebak-nebak.
Dokumentasi cepat usang jika tidak dirawat. Tombol berubah, menu pindah, alur login berganti, lalu artikel lama menjadi sumber kebingungan baru. Karena itu perlu ada kebiasaan mengecek ulang artikel penting, terutama setelah fitur berubah.
Knowledge base yang hidup tidak harus sempurna. Ia hanya perlu terus diperbaiki ketika ada pertanyaan baru, kesalahan baru, atau alur baru.
Knowledge base yang dipakai orang biasanya sederhana: judulnya jelas, bahasanya dekat, langkahnya bisa diikuti, dan isinya dirawat. Jika dokumentasi membantu orang menyelesaikan masalah tanpa harus bertanya lagi, berarti ia sudah bekerja.
Tinggalkan Komentar