Zsite

Menulis panduan (Docs)

Membuat dan mengelompokkan panduan pengguna seperti halaman ini, lengkap dengan tips, catatan, dan screenshot.

Terakhir diperbarui:

Menu Docs dipakai untuk pusat bantuan atau panduan pengguna. Panduan dikelompokkan per Section dan diurutkan dengan Order.

Daftar panduan: (1) tombol New guide, (2) judul section, (3) urutan, (4) judul panduan dan alamatnya.
Daftar panduan: (1) tombol New guide, (2) judul section, (3) urutan, (4) judul panduan dan alamatnya.

Membuat panduan#

  1. Buka menu Docs, lalu klik New guide.
  2. Isi Title.
  3. Isi Section. Pilih dari daftar section yang sudah ada, atau ketik nama baru.
  4. Isi Order. Angka lebih kecil tampil lebih dulu, dan urutan section mengikuti panduan pertama di dalamnya.
  5. Tulis Summary: satu sampai dua kalimat yang tampil di daftar dan hasil pencarian.
  6. Tulis isi panduan di Body (Markdown).
  7. Pilih status Published, lalu klik Save guide.
Editor panduan: (1) section, (2) urutan, (3) ringkasan, (4) contekan format.
Editor panduan: (1) section, (2) urutan, (3) ringkasan, (4) contekan format.

Format khusus panduan#

Buka Formatting cheat sheet di bawah kolom isi untuk melihat contohnya.

  • Judul ## ... otomatis masuk ke daftar Di halaman ini di sisi kanan.
  • Daftar bernomor tampil sebagai langkah-langkah berurutan.
  • > **Tip:** ..., > **Catatan:** ..., dan > **Peringatan:** ... menjadi kotak berwarna.
  • ![Teks alternatif](/media/file.jpg "Keterangan") menjadi screenshot dengan keterangan yang bisa diklik untuk diperbesar.

Tip Beri tanda (kotak dan nomor) pada screenshot, lalu jelaskan nomor-nomor tersebut di keterangannya. Pembaca akan lebih cepat menemukan tombol yang dimaksud.

Mengaktifkan halaman panduan#

Panduan baru tampil setelah Settings → Documentation → Enable documentation dicentang. Di sana Anda juga bisa mengubah judul, teks pembuka, dan kotak bantuan di akhir setiap panduan.