Pedoman Penulisan Panduan - JackMizh/Sisekar GitHub Wiki

Struktur Panduan

Panduan OpenSID terdiri dari banyak halaman wiki. Masing-masing halaman diusahakan tidak terlalu panjang dan diberi judul yang memudahkan untuk dicari.

Struktur panduan secara keseluruhan juga diusahakan untuk memudahkan penelusuran mengikuti rangkaian tautan. Strukturnya berpola hirarkis, di mana ada halaman menu utama yang mengarah kepada halaman utama suatu menu. Kemudian halaman menu itu mengarah ke masing-masing tab/submenu, dan seterusnya sampai semua fitur tercakup.

Penjelasan lebih lanjut ada di Struktur Panduan.

Penulisan Modul

Cara yang sistematik untuk membuat panduan untuk suatu modul dilakukan dengan pertama-tama menuliskan judul bagian untuk setiap fungsi yang disediakan oleh modul tersebut, misalnya menambah, mengubah, menghapus, mengimpor dstnya. Dengan cara ini, kita akan ketahui mana yang sudah dijelaskan dan mana yang masih kurang.

Ikuti cara penulisan teks panduan sebagai berikut:

1. Gunakan bahasa yang sederhana dan jelas.
2. Gunakan kalimat singkat dan terfokus.
3. Gunakan tampilan layar untuk menjelaskan penggunaan aplikasi.
4. Hindari halaman yang terlalu panjang. Buat halaman baru apabila perlu.
5. Lihat contoh halaman lainnya di Panduan OpenSID supaya memakai pengaturan halaman dan gaya bahasa yang konsisten.

Melihat Revisi Sebelumnya

Github menyimpan revisi halaman setiap kali anda melakukan Save Page. Dengan demikian anda tidak perlu khawatir tulisan sebelumnya akan hilang. Untuk melihat revisi sebelumnya, tekan tautan revisions, seperti terlihat di gambar berikut.

Tabel semua revisi akan ditampilkan. Klik suatu revisi untuk menampilkannya. Apabila perlu, revisi itu dapat dikembalikan menggantikan yang terkini.