Ada banyak hal yang saling bersaing untuk diseimbangkan saat menulis atau menyunting artikel. Anda ingin tulisan yang lengkap dan ringkas; faktual dan menarik pada saat yang bersamaan. Tentu saja ini bukanlah hal yang paling mudah untuk dilakukan di dunia. Berikut adalah beberapa panduan untuk membantu membuat tindakan penyeimbangan itu sedikit lebih mudah. Selain itu, ini adalah wiki dan kita selalu dapat merevisi sesuatu jika kita salah.
Daftar Isi
Untuk siapa kita menulis artikel?
Kami ingin Bantuan Thunderbird dapat digunakan oleh semua pengguna Thunderbird. Ini berarti kami menulis untuk audiens umum daripada seseorang yang sangat akrab dengan teknik dan terminologi komputer. Asumsikan orang yang Anda tuju tidak tahu cara mengubah preferensi atau menambahkan tombol bilah alat tanpa instruksi langkah demi langkah. Selain itu, kita harus berasumsi bahwa mereka belum mengubah pengaturan default Thunderbird atau sistem operasi apa pun.
Memilih judul yang baik
Saat memilih judul untuk sebuah artikel, kami ingin mencoba mencocokkan apa yang dicari dan dijelajahi orang — untuk mencocokkan pertanyaan yang mungkin mereka ajukan kepada Anda secara langsung. Berikut adalah beberapa contoh jenis judul yang harus Anda pilih:
- Untuk artikel tutorial atau cara: Bagaimana cara mencapai hasil ini? (misalnya, Bagaimana cara mengirim email?)
- Untuk artikel referensi: Apa itu Nama Fitur? (misalnya, Apa itu Plug-in?)
- Untuk artikel pemecahan masalah: Ini adalah masalah yang saya alami (misalnya, Thunderbird membutuhkan waktu lama untuk memulai)
Teknik untuk membuat tulisan Anda menarik
Bantuan Thunderbird adalah gudang informasi teknis tentang pengoperasian aplikasi klien email Thunderbird. Dokumentasi ini mencantumkan fungsi dari berbagai fitur Thunderbird, prosedur pemecahan masalah, dan instruksi untuk menyelesaikan masalah umum. Dokumentasi dapat diakses dengan menggunakan fungsi pencarian di setiap halaman.
Gunakan teknik dan panduan berikut saat Anda menulis artikel bantuan. Panduan ini akan membantu pengguna mempelajari cara menggunakan perangkat lunak atau cara menyelesaikan masalah spesifik yang mereka hadapi.
- Gaya penulisan percakapan – Gunakan gaya informal dan aktif yang mirip dengan cara Anda berbicara dengan seseorang secara langsung.
- Humor dan emosi – Jaga agar humor dan emosi seminimal mungkin. Jika sesuai, gunakan kiat dan saran yang membesarkan hati atau membantu dalam artikel untuk membantu pengguna menyelesaikan tugas. Menggunakan humor atau emosi lain tidak akan membantu pengguna dan bahkan dapat membuatnya frustrasi.
- Berbagai gaya belajar – Sama seperti di sekolah, orang belajar secara berbeda. Selain itu, semua orang mendapat manfaat dari melihat konten yang sama diungkapkan dengan berbagai cara.
- Pengulangan – Saat menjelaskan konsep atau tugas dengan cara yang berbeda, Anda tidak hanya mengulanginya, Anda juga membantu pengguna mempertahankan ide-ide kunci.
- Gambar dan video – Menggunakan gambar dan video untuk menjelaskan berbagai hal bersama dengan teks bukan hanya hal terbaik berikutnya untuk berada di sana untuk membantu secara langsung, itu adalah cara mudah untuk menyertakan berbagai gaya belajar dan pengulangan.
- Aktivitas – Terutama dalam tutorial, ada baiknya memberi orang sesuatu yang berguna untuk dicapai. Membaca instruksi dan memahami prosesnya adalah satu hal, tetapi sering kali membantu untuk mengingatkan orang untuk mencoba berbagai hal.
Artikel Protect your Thunderbird passwords with a Primary Password adalah contoh artikel yang baik yang menggunakan teknik-teknik ini.
Menulis pendahuluan yang baik
Bersama dengan judul dan daftar isi, pendahuluan adalah apa yang akan digunakan orang untuk dengan cepat menentukan apakah mereka berada di tempat yang tepat.
- Untuk artikel tutorial atau cara: Berikan ringkasan singkat tentang hal-hal apa saja yang dapat dipelajari.
- Untuk artikel referensi: Berikan penjelasan singkat tentang fitur tersebut.
- Untuk artikel pemecahan masalah: Berikan ringkasan singkat tentang masalah dan gejalanya.
Pendahuluan yang baik biasanya dapat berfungsi sebagai ringkasan pencarian yang baik. Seringkali Anda bisa langsung menyalinnya ke kolom "Ringkasan hasil pencarian" dan selesai.
Mengatur artikel
Ide umum di sini adalah mencoba membangun keterampilan dari yang sederhana hingga yang kompleks sambil mencoba menjaga informasi yang dibutuhkan oleh kebanyakan orang di bagian atas. Jadi solusi yang sederhana dan umum biasanya akan datang sebelum solusi yang kompleks atau kasus khusus.
Membuat instruksi langkah demi langkah mudah diikuti
Hal utama yang perlu diingat saat menulis instruksi langkah demi langkah adalah berhati-hati untuk menyertakan semua tindakan yang diperlukan untuk menyelesaikan tugas. Jika, misalnya, Anda harus mengeklik "OK" setelah memilih preferensi untuk melanjutkan ke langkah berikutnya, pastikan untuk menyertakan mengeklik OK sebagai bagian dari langkah itu. Beberapa hal tambahan yang perlu dipertimbangkan:
- Selalu ada banyak cara untuk mencapai suatu hasil. Kita harus selalu memilih cara yang paling ramah pengguna, yaitu, menggunakan antarmuka pengguna grafis dan menu jika memungkinkan.
- Gunakan kalimat lengkap saat menjelaskan cara mengakses antarmuka pengguna.
- Sertakan hasil yang diharapkan saat memberikan instruksi (misalnya, Klik OK dan jendela akan tertutup).
Berikut adalah contoh dari artikel Protect your Thunderbird passwords with a Primary Password dengan beberapa penjelasan dalam tanda kurung.
Mengubah atau menghapus kata sandi utama
(Judul — apa yang akan dicapai oleh langkah-langkah tersebut)
Anda dapat mengubah atau menghapus kata sandi utama Anda kapan saja:
(Konteks - menunjukkan gambaran besar — mengapa kita melakukan ini)
- Di bagian atas jendela Thunderbird, klik menu , dan pilih .
- Klik ikon .
- Klik tab .
- Klik .
- Masukkan kata sandi saat ini untuk mengonfirmasi bahwa Anda berwenang untuk mengubahnya.
- Jika Anda lupa kata sandi utama Anda, lihat Reset your Primary Password if you've forgotten it.
- Masukkan kata sandi utama yang baru dua kali.
- Untuk menghapus kata sandi utama, biarkan kolom kata sandi utama yang baru kosong.
- Untuk menerima kata sandi utama yang diubah, klik .
- Kata sandi utama telah diubah.
Panduan gaya SUMO
Seperti yang kita bicarakan sebelumnya, Anda harus menggunakan gaya percakapan yang aktif saat menulis. Jadi, Anda harus menghindari mengatakan hal-hal seperti, "Jika markah pengguna telah hilang..." dan sebaliknya katakan, "Jika Anda kehilangan markah Anda..." Berikut adalah masalah gaya umum lainnya yang mungkin Anda temui saat menulis artikel dukungan:
Selalu gunakan istilah seperti yang muncul di antarmuka Thunderbird. Contohnya:
- Plugins tidak memiliki tanda hubung.
- Add-ons memiliki tanda hubung.
- Home page adalah dua kata.
Istilah komputasi umum:
- internet menggunakan huruf kecil.
- Website adalah satu kata.
- Log in dan log out adalah kata kerja, misalnya, "Log in ke situs web."
- Login dan logout adalah kata benda (biasanya digunakan sebagai kata sifat), misalnya, "Klik tombol login."
- Gunakan email, bukan e-mail.
- Bentuk jamak dari CD-ROM adalah CD-ROMs.
Tautan ke situs web tidak boleh berisi lokal:
- Gunakan https://addons.mozilla.org/thunderbird/ alih-alih https://addons.mozilla.org/en-US/thunderbird/
Gunakan huruf kapital untuk item berikut:
- Kata benda nama diri
- Kata pertama dari kalimat lengkap
- Huruf-huruf singkatan dan akronim kecuali jika biasanya ditulis dengan huruf kecil
- Kata pertama dalam daftar bernomor atau berpoin
- Nama tombol pada papan tik
- Kata pertama dari kalimat lengkap setelah titik dua
- Kata pertama dalam judul atau tajuk
Judul dan Bagian
Wiki kami ditampilkan menggunakan HTML5 yang menggunakan elemen <section>. Anda dapat menggunakan elemen <section> di sekitar konten terkait. Artinya untuk judul adalah bahwa setiap bagian dapat memiliki kerangkanya sendiri yang dimulai dengan judul tingkat h1.
Demi kejelasan, hindari penggunaan i.e dan e.g. Jika Anda harus menggunakannya, berikut adalah penjelasan yang bagus tentang cara melakukannya.
Kami memiliki gaya visual khusus untuk sejumlah item yang dapat dicapai dengan menambahkan markup wiki yang tepat di sekitar item (lihat bagan markup Basis Pengetahuan Firefox dan Thunderbird untuk daftar lengkap).
- Catatan
- Peringatan
Kode- File names dan file/paths
- Pintasan papan tik seperti Ctrl + T
- Jalur menu –
Kami memiliki markup wiki khusus – {for} – yang memungkinkan Anda menargetkan informasi untuk versi Thunderbird tertentu atau sistem operasi tertentu. Misalnya, Anda menampilkan satu set instruksi untuk orang yang menjalankan Windows dan yang lain untuk orang yang menggunakan Mac OS X (Lihat bagian panduan markup kami "SHOWFOR ", untuk detailnya).
