Sebagai kontributor basis pengetahuan, Anda menggunakan kata-kata untuk membantu setengah miliar pengguna. Itu adalah pekerjaan besar. Pengguna datang ke basis pengetahuan dari seluruh dunia, dan mereka mengharapkan solusi yang mudah, tetapi kami juga ingin menyenangkan mereka dengan suara kami. Bagaimana Anda melakukannya? Berikut adalah beberapa hal yang kami temukan dalam penelitian kami.
Daftar Isi
- 1 Nada
- 2 Gaya penulisan
- 3 Gaya penulisan (komprehensif)
- 4 Jenis artikel
- 5 Mulailah dengan judul yang efektif dan deskriptif
- 6 Tulis pendahuluan yang baik
- 7 Susun artikel secara efektif
- 8 Buat instruksi langkah demi langkah mudah diikuti
- 9 Keterbacaan
- 10 Cara menautkan ke dokumentasi eksternal untuk perangkat lunak pihak ketiga
- 11 Panduan teknis
- 12 Judul
- 13 Slug
- 14 Kategori, produk, dan topik
- 15 Kata Kunci
- 16 Tulis ringkasan pencarian yang baik
- 17 Jumlah langkah
- 18 Struktur paralel
- 19 Isyarat arah
- 20 Panduan gaya dan aturan penulisan
Nada
Menulislah dengan mempertimbangkan merek. Mozilla adalah tentang pilihan pengguna. Kami percaya pada kebebasan dan fleksibilitas. Kami menghargai privasi dan keamanan. Kami adalah organisasi nirlaba yang digerakkan oleh komunitas dengan kontributor di seluruh dunia yang memiliki nilai-nilai yang sama.
Anda tidak perlu memaksakan cerita ini setiap kali Anda menulis artikel. Ini hanyalah sesuatu yang perlu diingat saat Anda mendeskripsikan fitur.
Gaya penulisan
Tulislah untuk audiens umum dan non-teknis.
Kami ingin artikel kami dapat digunakan oleh semua orang, bukan hanya pengguna tingkat lanjut. Ini berarti kami menulis untuk audiens umum daripada 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 aplikasi atau sistem operasi bawaan apa pun.
Singkatnya, Anda harus mengikuti panduan ini:
- Buatlah tetap singkat. Orang-orang datang ke basis pengetahuan untuk mencari solusi cepat. Mereka mungkin tidak peduli tentang cara kerja alat tersebut – mereka hanya ingin tahu apa yang harus mereka lakukan untuk memperbaikinya. Silakan pangkas beberapa kata. Lihat seberapa banyak yang bisa Anda sampaikan dengan lebih sedikit kata. Ini seperti puisi!
- Buatlah tetap jelas. Hindari jargon. Jadilah spesifik. Gunakan kata-kata dalam judul dan dalam artikel yang akan digunakan pembaca. Jika keponakan Anda yang berusia 13 tahun tidak akan memahaminya, tulislah agar dia mengerti. Lihat bagian selanjutnya untuk panduan yang lebih luas.
- Jadilah ramah, menyenangkan, dan berempati. (Singkatnya: Jadilah manusia.) Oke, jadi pengguna tidak datang ke dukungan mengharapkan kesenangan. Itulah yang membuat ini kuat. Cerahkan hari pengguna dengan sedikit humor. Tapi hati-hati jangan sampai mengorbankan kejelasan dengan menggunakan metafora atau ekspresi yang menyenangkan. Jika Anda tidak yakin bagaimana menyeimbangkan ini, cukup tulis instruksi yang lugas dan gunakan nada di pendahuluan atau kesimpulan.
- Ceritakan sebuah kisah. Miliki awal, tengah, dan akhir. Tapi jangan menulis novel (lihat panduan #1).
- Awal: ini memberi pembaca beberapa konteks. Tentang apa artikel ini dan mengapa saya harus peduli? Buatlah tetap singkat.
- Tengah: Instruksi ada di sini. Ini harus menjawab “Bagaimana cara melakukannya?”
- Akhir: Apakah ada langkah selanjutnya untuk artikel atau fitur tersebut? Beri tahu pembaca ke mana dia harus pergi selanjutnya jika mereka ingin belajar lebih banyak.
Baca bagian selanjutnya untuk panduan yang lebih komprehensif.
Gaya penulisan (komprehensif)
- Gaya penulisan percakapan – Gunakan gaya informal dan aktif yang mirip dengan cara Anda berbicara dengan seseorang secara langsung.
- Humor dan emosi – Menggunakan humor itu bagus, tetapi terkadang sulit atau tidak mungkin untuk dilokalkan. Emosi seperti kejutan dan “Saya tidak tahu itu/Eureka!” mungkin lebih mudah untuk disertakan.
- 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 – Ketika Anda menjelaskan sesuatu dengan cara yang berbeda dengan media yang berbeda, Anda juga, jelas, mengulanginya yang merupakan cara baik lain untuk membantu orang mengingat apa yang penting.
- Gambar dan video – Menggunakan gambar dan video bersama dengan teks bukan hanya hal terbaik berikutnya untuk membantu secara langsung, ini adalah cara mudah untuk menyertakan berbagai gaya belajar dan pengulangan. Namun, terlalu banyak gambar dapat membuat pelokalan artikel menjadi lebih sulit, jadi cobalah untuk menambahkan gambar hanya jika itu membantu untuk suatu langkah atau konsep. Misalnya, untuk langkah mengklik tombol, Anda bisa mengatakan “Klik ” alih-alih menambahkan tangkapan layar dari kotak dialog tombol itu.
- 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 dan memungkinkan orang untuk mencoba berbagai hal.
Jenis artikel
Menggunakan jenis konten yang konsisten untuk artikel basis pengetahuan kami memiliki banyak manfaat termasuk kemudahan navigasi dan peningkatan kejelasan dan organisasi, selain membantu kami membuat konten lebih efektif. Kami sedang beralih ke pengkategorian artikel basis pengetahuan eksternal menjadi empat jenis, masing-masing melayani tujuan tertentu:
- Tentang: Artikel-artikel ini menjawab pertanyaan “Apa itu…”, memberikan informasi penting untuk membantu pembaca memahami suatu topik.
- Cara: Artikel-artikel ini berfokus pada menjawab pertanyaan “Bagaimana cara…?”, memandu pembaca melalui langkah-langkah yang diperlukan untuk mencapai tujuan atau prosedur tertentu.
- Pemecahan masalah: Artikel-artikel ini membantu pengguna dalam mengidentifikasi, mendiagnosis, dan menyelesaikan masalah umum yang mungkin mereka hadapi dengan produk, layanan, atau fitur dengan menjawab pertanyaan “Bagaimana cara…?” yang berkaitan dengan pemecahan masalah.
- FAQ: Artikel-artikel ini berisi jawaban singkat atas pertanyaan yang sering diajukan tentang satu topik, yang mungkin tidak cocok dengan artikel KB individual lainnya, memberikan referensi cepat untuk pertanyaan umum.
Mulailah dengan judul yang efektif dan deskriptif
Judul yang dibuat dengan baik lebih dari sekadar label; itu adalah titik kontak pertama pengguna dengan artikel KB Anda. Judul yang baik tidak hanya harus menarik perhatian pembaca, tetapi juga berfungsi sebagai pratinjau konten artikel yang ringkas dan informatif. Saat membuat judul untuk SUMO, pertimbangkan hal berikut:
- Kejelasan dan Deskriptif: Sesuaikan dengan isi artikel dan apa yang dicari pengguna. Jadilah ringkas, namun berfokus pada pengguna.
- Penyertaan Kata Kunci: Masukkan kata kunci yang relevan untuk meningkatkan visibilitas mesin pencari dan membantu pengguna menemukan artikel Anda.
- Keringkasan: Buat judul tetap singkat sambil tetap memberikan informasi yang memadai. Judul yang lebih pendek seringkali lebih ramah pengguna. Usahakan agar judul sekitar 60 karakter.
- Berorientasi pada tindakan: Gunakan kata kerja tindakan jika berlaku untuk menunjukkan apa yang dapat dilakukan pengguna untuk menyelesaikan masalah atau mencapai tujuan. Hindari penggunaan gerund (kata yang berakhiran “ing”) dalam judul untuk memastikan judul tetap berorientasi pada tindakan. Hindari penggunaan judul yang mengandung “Bagaimana cara…”
Tulis pendahuluan yang baik
Bersama dengan judul dan daftar isi, pendahuluan adalah apa yang akan membantu pengguna menentukan apakah mereka berada di tempat yang tepat.
- Untuk artikel “Tentang”: Berikan gambaran umum tekstual atau definisi konsep dan fokus pada mengapa pengguna harus peduli tentangnya.
- Untuk artikel “Cara”: Berikan gambaran umum tekstual atau definisi tugas dan fokus pada pentingnya atau manfaat dari tugas tersebut.
- Untuk artikel “Pemecahan Masalah”: Jelaskan masalah atau gejala spesifik yang mungkin dihadapi pengguna. Tulislah dalam bahasa yang jelas dan ringkas, hindari jargon teknis jika memungkinkan.
Ingatlah bahwa pendahuluan yang baik biasanya dapat berfungsi sebagai ringkasan pencarian yang baik. Seringkali Anda bisa menyalinnya ke kolom “Ringkasan hasil pencarian” dan selesai.
Susun artikel secara efektif
Gagasan umum di sini adalah mencoba membangun keterampilan dari yang sederhana hingga yang kompleks sambil mencoba menjaga informasi yang dibutuhkan oleh sebagian besar orang di bagian atas. Jadi solusi yang sederhana dan umum biasanya akan datang sebelum solusi yang kompleks atau kasus khusus.
Buat 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 mengklik setelah memilih preferensi untuk melanjutkan ke langkah berikutnya, pastikan untuk menyertakan mengklik “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 dengan 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.).
Keterbacaan
Teks harus dapat dibaca. Untuk melakukan ini, Anda harus:
- Membagi artikel menjadi blok-blok logis/semantik kecil dengan subjudul.
- Menggunakan daftar bernomor atau berpoin.
- Menulis kalimat pendek atau relatif pendek.
- Hindari menulis paragraf besar.
Tidak ada batasan jumlah teks. Semakin banyak materi, semakin baik; namun, Anda tidak boleh mengembangkannya secara artifisial. Berikan hanya informasi yang berguna, berharga, dan perlu.
Cara menautkan ke dokumentasi eksternal untuk perangkat lunak pihak ketiga
Saat membuat atau memperbarui artikel yang melibatkan tindakan dalam perangkat lunak pihak ketiga, seperti sistem operasi atau aplikasi eksternal, sangat penting untuk memberikan informasi yang akurat dan andal kepada pengguna. Namun, menyertakan langkah-langkah langsung untuk perangkat lunak ini dalam artikel kami dapat menimbulkan tantangan:
- Informasi yang cepat usang: Pembaruan perangkat lunak pihak ketiga dapat membuat instruksi kami menjadi usang, berpotensi membingungkan atau menyesatkan pengguna kami.
- Intensif sumber daya: Terus memantau dan memperbarui langkah-langkah untuk beberapa platform eksternal akan membutuhkan upaya dan sumber daya yang signifikan, yang mungkin tidak dapat dilakukan.
Praktik terbaik
Untuk memastikan pengguna kami menerima informasi yang paling andal dan terkini tanpa membebani sumber daya kami, ikuti praktik terbaik ini:
- Tautkan ke sumber daya resmi: Setiap kali instruksi melibatkan perangkat lunak pihak ketiga, temukan dokumentasi resmi atau artikel bantuan yang disediakan oleh pembuat perangkat lunak. Tautkan ke sumber daya ini alih-alih menulis langkah-langkahnya secara langsung di artikel kami.
- Berikan konteks: Jelaskan secara singkat mengapa Anda mengarahkan pengguna ke halaman eksternal (misalnya: "Untuk langkah-langkah terbaru dan paling akurat untuk menyesuaikan pengaturan sistem Anda, silakan merujuk ke halaman dukungan resmi [nama perangkat lunak]").
- Periksa tautan secara berkala: Meskipun kami bertujuan untuk mengurangi pemeliharaan instruksi pihak ketiga, memeriksa secara berkala bahwa tautan eksternal masih valid tetap penting. Jika Anda melihat tautan menjadi usang atau rusak, cari tautan yang diperbarui ke dokumentasi resmi dan kirimkan revisi.
- Penafian tentang konten eksternal: Saat mengarahkan pengguna ke tautan eksternal, jelaskan bahwa mereka akan meninggalkan SUMO dan bahwa kami tidak bertanggung jawab atas konten situs eksternal. Penafian atau catatan sederhana sudah cukup (misalnya “Mengikuti tautan ini akan mengarahkan Anda ke situs web eksternal yang tidak dioperasikan oleh Mozilla.”).
Contoh
Bayangkan Anda sedang menulis artikel tentang mengonfigurasi fitur Firefox yang bergantung pada perubahan pengaturan tingkat sistem di Mac. Alih-alih menguraikan langkah-langkahnya secara langsung di artikel, Anda mungkin menulis:
Untuk langkah-langkah terbaru dalam menyesuaikan preferensi sistem Anda di macOS, silakan lihat dokumentasi dukungan resmi Apple dengan mengunjungi panduan ini. Harap dicatat bahwa mengikuti tautan itu akan mengarahkan Anda ke situs web eksternal yang tidak dioperasikan oleh Mozilla.
Ini memastikan Anda mengikuti instruksi terbaru langsung dari sumbernya.
Panduan teknis
- Untuk mempelajari cara membuat artikel baru, lihat Buat artikel Basis Pengetahuan baru.
- Untuk mempelajari cara mengedit artikel yang sudah ada, lihat Sunting artikel Basis Pengetahuan.
- Lihat About the Knowledge Base untuk gambaran umum tentang cara kerja Basis Pengetahuan.
- Lihat Improve the Knowledge Base untuk daftar lengkap dokumentasi artikel.
Judul
- Panjang judul: Halaman hasil pencarian Google akan menampilkan hingga 60 karakter. Judul Anda bisa lebih panjang dari ini jika perlu tetapi pastikan kata kunci penting Anda disertakan dalam 60 karakter pertama.
- Kapitalisasi: Kata pertama dalam judul harus dikapitalisasi, serta kata benda khas dan nama, bukan setiap kata utama. Gunakan gaya “kalimat”, bukan gaya “judul utama”. (Hal yang sama berlaku untuk judul tajuk. Lihat bagian Panduan gaya dan aturan penulisan di bawah untuk aturan lain tentang kapitalisasi.) Namun, jangan mengedit judul artikel yang sudah ada untuk mengubah kapitalisasi kecuali Anda membuat perubahan judul lain, karena pengalihan tidak akan dibuat dan tautan wiki yang rusak di artikel yang menautkan ke sana akan terjadi (bug 1969540).
- Jangan gunakan titik dua dalam judul artikel karena mencegah pembuatan tautan wiki ke artikel tersebut (bug 749835). Pastikan juga Anda tidak memiliki spasi ekstra di judul artikel, yang juga akan mencegah tautan wiki berfungsi.
- Cobalah untuk memvariasikan cara Anda menamai artikel. Jangan gunakan kata atau frasa yang sama di setiap judul. Misalnya, jangan selalu memulai artikel dengan “Bagaimana” dan hindari menggunakan nama tugas “ing” seperti “Mengatur halaman beranda”.
- Ingatlah bahwa seluruh penjelasan tidak harus masuk ke dalam judul. Anda dapat menggunakan ringkasan untuk memberikan informasi tambahan kepada pengguna tentang apa yang ada di dalam artikel.
Slug
Saat Anda membuat artikel baru dan memasukkan judul, SUMO akan secara otomatis membuat slug (bagian setelah kb/ di akhir URL untuk artikel tersebut). Seorang peninjau dapat mengedit judul artikel yang ada tetapi slug tetap sama, kecuali diubah secara manual (ini disengaja). Slug memiliki batas 50 karakter. Spasi dirender sebagai tanda hubung. Slug harus konsisten dengan judul, tetapi mengingat batasan ruang yang lebih ketat, tidak harus sama.
Perbaiki slug
Pastikan untuk memeriksa akhir dari slug yang dibuat secara otomatis. Terkadang sebuah kata terpotong atau berakhir dengan tanda hubung. Harap perbaiki hal-hal seperti itu.
Memperbarui slug dari artikel yang sudah ada
Saat Anda memperbarui judul artikel yang sudah ada, biarkan slug saat ini tidak berubah kecuali judul baru tersebut mewakili perubahan signifikan yang tidak lagi selaras dengan slug yang ada. Menjaga slug tetap konsisten membantu menghindari tautan yang rusak dan mempertahankan nilai SEO.
Kategori, produk, dan topik
Untuk sebagian besar, sebuah artikel termasuk dalam kategori Cara atau Pemecahan Masalah. Kadang-kadang, kami menulis artikel di salah satu kategori lain, seperti artikel “Cara Berkontribusi” (seperti yang ini). Halaman Riwayat artikel akan menunjukkan kategori tersebut.
Artikel juga “relevan dengan” setidaknya satu produk. Mereka juga termasuk dalam satu “Topik” utama dan secara opsional, “sub-topik”.
Kata Kunci
Kolom kata kunci dalam sebuah artikel dapat digunakan untuk meningkatkan hasil pencarian di SUMO. Namun, kolom ini harus digunakan hanya dalam keadaan tertentu, karena penyalahgunaan justru dapat merusak pencarian. Kami jarang perlu menggunakan kata kunci. Untuk detailnya, lihat Kapan dan Bagaimana untuk menggunakan Kata Kunci untuk menaikan peringkat pencarian artikel.
Tulis ringkasan pencarian yang baik
Ringkasan artikel, bersama dengan judul, membantu pengguna menilai apakah sebuah artikel akan menjawab pertanyaan mereka. Kami menyebut ini “Keyakinan Pengguna” dan ini secara langsung memengaruhi rasio klik-tayang. Bahkan jika kami menyajikan artikel yang benar di bagian atas daftar hasil pencarian, pengguna perlu membuat hubungan mental antara kueri pencarian dan hasil yang kami tampilkan agar mereka dapat mengklik artikel tersebut.
Ringkasan untuk artikel cara harus menyertakan topik yang dibahas dalam artikel. Artikel pemecahan masalah harus mencoba menyertakan gejala. Selain itu, ringkasan harus mengikuti panduan ini:
- Singkat dan langsung ke intinya. Ingat iklan baris? Tulislah seperti itu. Mesin pencari dapat memotong apa pun yang lebih dari 140 karakter. Jika Anda menggunakan ringkasan yang lebih panjang, simpan informasi penting di awal. Catatan: Perangkat lunak KB akan menunjukkan 20 karakter tersisa ketika ringkasan mencapai 140 karakter karena batas pencarian internal adalah 160.
- Jangan gunakan markup wiki.
- Jangan gunakan “Artikel ini menjelaskan” di setiap ringkasan. Variasikan jika memungkinkan. Beberapa frasa lain yang perlu dipertimbangkan:
- Kami akan menunjukkan kepada Anda
- Kami akan menjelaskan
- Halaman ini menjelaskan
- Artikel ini menjelaskan
- Pelajari cara
Jumlah langkah
Saat memandu pengguna melalui suatu proses, pertimbangkan daftar berurutan (daftar bernomor). Umumnya merupakan praktik yang baik untuk mencoba dan menjaga jumlah total langkah dalam rentang enam-tujuh.
Struktur paralel
Gunakan frasa atau pola kata yang sama untuk setiap langkah yang Anda tulis. Struktur paralel penting dalam artikel KB karena membuat segalanya jelas dan mudah diikuti. Ketika elemen serupa memiliki format yang konsisten, pengguna dapat memahami dan menyelesaikan tugas dengan lebih lancar. Struktur ini menyederhanakan instruksi, mengurangi kesalahan, dan memastikan informasi disampaikan secara efektif.
Sebagai contoh:
- Temukan Hapus riwayat saat Firefox ditutup. Jika dipilih:
- Klik tombol .
- Pastikan Riwayat Formulir & Pencarian tidak dipilih.
- Klik .
Isyarat arah
Isyarat arah adalah referensi atau indikator yang memandu pengguna ke lokasi atau posisi spesifik dalam antarmuka pengguna di mana mereka perlu melakukan tindakan tertentu. Isyarat ini membantu pengguna menavigasi dan berinteraksi dengan perangkat lunak, aplikasi, atau situs web secara lebih efektif. Biasanya isyarat ini mencakup frasa seperti “Di sudut kanan atas,” “Di menu sebelah kiri,” atau “Di bawah bilah pencarian,” yang memberikan pengguna pemahaman yang jelas tentang di mana menemukan dan melakukan tindakan.
Dalam instruksi artikel KB Anda, pastikan untuk memberikan isyarat arah sebelum tindakan. Misalnya, alih-alih mengatakan Klik tombol, gunakan Di sudut kanan atas, klik tombol. Format ini membantu pengguna dengan mudah menemukan dan melakukan tindakan dalam antarmuka.
Panduan gaya dan aturan penulisan
Seperti yang kami katakan sebelumnya, Anda harus menggunakan gaya percakapan yang aktif saat menulis. Hindari mengatakan hal-hal seperti, “Jika markah pengguna telah hilang” dan sebaliknya katakan, “Jika Anda kehilangan markah Anda”. Berikut adalah masalah gaya dan penulisan umum lainnya yang mungkin Anda temui saat menulis artikel dukungan: Selalu gunakan istilah seperti yang muncul di antarmuka Mozilla. Sebagai contoh:
- Plugins tidak memiliki tanda hubung.
- Add-ons memiliki tanda hubung.
- Home page adalah dua kata.
Istilah komputasi umum:
- Website adalah satu kata. Web page adalah dua kata.
- Log in dan log out adalah kata kerja. Contoh: “Log in ke situs web.” Hal yang sama berlaku untuk sign in dan sign out. Jangan gunakan “log into” atau “sign into”.
- Login dan logout adalah kata benda (biasanya digunakan sebagai kata sifat). Contoh: “Klik tombol login.”
- Gunakan email alih-alih e-mail.
- Bentuk jamak dari CD-ROM adalah CD-ROMs.
Tautan ke mozilla.org dan firefox.com tidak boleh berisi lokal:
- Gunakan https://www.mozilla.org/ alih-alih https://www.mozilla.org/en-US/
- Gunakan https://www.firefox.com/ alih-alih https://www.firefox.com/en-US/
Saat memasukkan tautan ke dalam kalimat:
- Hindari menggunakan “klik di sini” atau “di sini” sebagai teks tautan.
- Lakukan: Buka pengaturan akun Anda untuk membatalkan langganan Anda.
- Jangan: Klik di sini untuk membatalkan langganan Anda.
Kapitalisasi item berikut:
- Kata benda khas dan nama, termasuk nama merek, nama produk, dan nama fitur
- Kata pertama dari kalimat lengkap
- Huruf-huruf singkatan dan akronim, kecuali jika biasanya huruf kecil
- Kata pertama dalam daftar bernomor atau berpoin
- Nama tombol pada papan ketik
- Kata pertama dari kalimat lengkap setelah titik dua
- Kata pertama dalam tajuk atau judul
Mozilla accounts:
- Huruf “a” dalam Mozilla accounts selalu huruf kecil kecuali dalam item navigasi di mana ia disertakan dengan item navigasi lain yang menggunakan kapitalisasi judul.
- Selalu gunakan “sign in” dan “sign out”.
- Dalam bentuk kata kerja, gunakan “sign in to your account” (bukan “sign into”) agar benar secara tata bahasa.
- Anda juga dapat menggunakan “Sign in with Mozilla”.
- “Sign” harus selalu digunakan sebagai kata kerja. Jika Anda menggunakannya sebagai kata benda, gunakan “login”.
- Gunakan “sign up” sebagai ajakan untuk membuat akun baru.
Untuk detail tentang cara merujuk ke Mozilla accounts di artikel KB, lihat Editorial guidelines for Mozilla accounts.
Jangan gunakan “i.e.” dan “e.g.”. Singkatan Latin ini dapat membingungkan orang. Demi kejelasan, gunakan “dengan kata lain” atau “dengan kata lain” alih-alih i.e. ketika Anda ingin menjelaskan sesuatu dengan cara yang berbeda. Gunakan “misalnya”, “contohnya” atau “seperti” alih-alih e.g. ketika Anda ingin memberikan contoh.
Jangan gunakan koma serial dalam daftar item. Misalnya, gunakan “Ekstensi, tema, dan plugin” (tanpa koma serial), bukan “Ekstensi, tema, dan plugin”.
Gunakan inisialisme yang dianggap umum dipahami. Sebagai contoh:
- HTTP
- USB
- URL
Angka yang muncul dalam versi produk, kode kesalahan, tombol, dan tombol tidak akan dieja.
Tulis instruksi dalam suara aktif. Tulis instruksi dalam suara aktif. Suara aktif dan kala kini menyederhanakan instruksi, membuatnya lebih mudah diikuti dan mendorong tindakan cepat. Contoh:
“Mulai ulang Firefox untuk memperbarui” bukan “Firefox harus dimulai ulang”.
Eja garis miring terbalik(\) dan garis miring(/) untuk jalur dan pencarian untuk menghindari kebingungan.
Contoh: “Beberapa nama jalur ke gambar berisi garis miring terbalik (\\)”.
Pintasan papan ketik Kapitalisasi huruf pertama dari pintasan papan ketik atau kombinasi pintasan: Ctrl + Shift + C atau Command + Shift + C.
Jangan gunakan bahasa gaul dan idiom. Semua artikel kami diterjemahkan ke dalam banyak bahasa yang berbeda, sehingga dibaca dan diterjemahkan oleh penutur bahasa Inggris non-asli. Bahasa gaul dan idiom bisa ambigu yang dapat membingungkan pembaca dan membuat terjemahan lebih sulit.
Kami memiliki gaya visual khusus untuk sejumlah item yang dapat dicapai dengan menambahkan markup wiki yang tepat di sekitar item tersebut. Lihat Lembar contekan markup untuk gaya yang paling umum.
Kami memiliki markup wiki khusus – {for} – yang memungkinkan Anda menargetkan informasi untuk versi Firefox tertentu atau sistem operasi tertentu. Misalnya, Anda menampilkan satu set instruksi untuk orang yang menjalankan Windows dan yang lain untuk orang yang menggunakan macOS (lihat How to use "For" tags untuk detailnya).