Materi
Pedoman kontributor dokumentasi Elastic memberi aturan tertulis untuk halaman troubleshooting. Satu halaman membahas satu masalah utama. Judulnya menggambarkan masalah dari sudut pandang pengguna, misalnya “Struk tidak tercetak setelah pembayaran”; judul umum seperti “Troubleshooting printer” hanya untuk halaman penunjuk yang mengumpulkan banyak masalah. Diátaxis menggolongkan troubleshooting sebagai panduan cara, karena pembacanya sedang bekerja dan ingin masalahnya selesai.
Bagian Gejala wajib ada: hanya perilaku yang bisa dilihat pengguna, tanpa menjelaskan penyebab, ditulis berbutir, dan memuat teks pesan galat persis seperti tampil, karena pengguna mencari dengan teks itu. Bila gejala yang sama bisa berasal dari beberapa penyebab, tambahkan bagian Diagnosis sebelum Penyelesaian untuk mempersempit penyebabnya. Bagian Penyelesaian wajib ada: langkah bernomor, diurutkan dari penyebab yang paling sering ke yang paling jarang, dengan anggapan keadaan pembaca cocok dengan Gejala. Halaman troubleshooting tidak dipakai untuk mengajari fitur pertama kali (itu tutorial) atau mendaftar pilihan konfigurasi (itu rujukan).
| Bagian | Contoh (SiHadir, karangan) |
|---|---|
| Judul | Tombol Absen masuk tidak aktif di kantor |
| Gejala | Tombol Absen masuk berwarna abu-abu; muncul pesan “Di luar zona kehadiran” |
| Diagnosis | Buka Profil > Lokasi dan periksa apakah izin lokasi aktif |
| Penyelesaian | 1. Aktifkan izin lokasi. 2. Tutup dan buka lagi SiHadir. |
