Tips untuk gaya artikel, tata bahasa, konten, dan SEO
Tips ini akan membantu artikel Anda melaju mulus melewati proses edit. Bersikaplah baik kepada editor Anda, dan baca ini sebelum Anda mulai.
Markup
Aturan utama: jangan terlalu macam-macam. Keterbacaan itu penting.
-
Jangan mencampur font monospace dengan font proporsional dalam satu kalimat. Gunakan huruf miring untuk teks khusus. Misalnya, jangan menulis
dnf install foodi tengah kalimat, tulislah dnf install foo. -
Gunakan huruf miring untuk objek sistem yang Anda sebutkan dalam kalimat:
-
Elemen GUI atau CLI seperti teks tombol atau entri menu
-
Prompt lain yang harus ditemukan pembaca di layar
-
Perintah atau nama paket
-
-
Use the Preformatted style in the WPEngine editor for command line input or output. Use a shell prompt ($ or #) only where it genuinely affects the meaning, or to set the input apart from output. It also helps to use boldface for the input itself:
$ command arg1 arg2 baris output 1 baris output 2
-
Gunakan huruf tebal hanya untuk frasa atau pernyataan yang sangat penting.
Tips tata bahasa dan gaya
-
Gunakan sentence case untuk judul postingan dan judul heading. Jangan mengapitalkan kata dalam judul artikel atau heading apa pun, selain nama diri. Ini menghindari perdebatan yang tidak perlu tentang title case, yang berbeda-beda menurut wilayah.
-
Heading yang salah: Use Sentence Case for Post Titles in Fedora Magazine
-
Heading yang benar: Use sentence case for post titles in Fedora Magazine
-
-
Periksa ejaan dan tata bahasa. Tidak ada yang suka komentar rewel soal ini. Periksa pekerjaan Anda sebelum Anda mengirimkannya kepada editor. Editor: periksa ulang semua pekerjaan, itu tugas Anda!
-
Menulislah dengan jelas dan gunakan kalimat yang lebih pendek. Ringkas itu baik. Jelas itu lebih baik. Jangan terlalu bertele-tele jika bisa dihindari. Jika kalimat yang lebih panjang lebih mudah dibaca, gunakan kata tambahan itu.
-
Hindari kalimat pasif. Kalimat pasif adalah penggunaan objek kalimat sebagai subjek. Contohnya:
-
Kalimat aktif: The troops defeated the enemy.
-
Kalimat pasif: The enemy was defeated by the troops.
-
-
Hati-hati dengan gerund (kata berakhiran -ing). Ini biasanya menandakan kalimat pasif. Tulis ulang kalimat Anda agar lebih kuat. Contohnya:
-
Lemah, kalimat pasif: Setting the foobar configuration option will make the application listen on all interfaces.
-
Kuat, kalimat aktif: Set the foobar configuration option to make the application listen on all interfaces.
-
-
Hindari penggunaan future tense yang tidak perlu. Kecuali Anda benar-benar membicarakan rencana atau publikasi di masa depan, present tense adalah yang terbaik.
-
Future tense yang tidak perlu: When you select Run, your program will start.
-
Present tense: When you select Run, your program starts.
-
-
Hindari terlalu sering menggunakan verba to be dalam kalimat. Terlalu sering memakai is, will be, atau can be membuat kalimat Anda lemah dan lembek. Cobalah memakai bentuk verba dari kata-kata yang Anda “pindahkan” ke bagian lain dalam kalimat. Sering kali Anda bisa langsung menghapus beberapa kata, atau memakai bentuk imperatif (memberi perintah atau saran) dalam kalimat.
-
Lemah: Zambone is an app used for managing your private documents on a server.
-
Kuat: Zambone manages your private documents on a server. Atau: Use Zambone to manage your private documents on a server.
-
Lemah: When setting up a file server, it is important to plan the directory structure carefully.
-
Kuat: Plan the directory structure of the file server carefully before you set it up.
-
-
Gunakan US English standar untuk ejaan dan perbedaan internasional lainnya. US English adalah lingua franca untuk Fedora Project secara keseluruhan.
-
Pastikan alurnya mulus dari informasi umum ke instruksi yang spesifik. Jika Anda tidak yakin cara menyusun artikel seperti ini, lihat template awal kami.
Tips konten
Tips ini membahas hal-hal yang perlu dilakukan — dan dihindari — dalam instruksi yang Anda berikan kepada pengguna. Ingat bahwa ribuan pembaca mempercayai Fedora Magazine untuk memberi tahu mereka cara menjalankan tugas. Bersikaplah bertanggung jawab dan membantu, anjurkan praktik terbaik, serta hormati keamanan dan pilihan pengguna.
-
Biarkan file terpaket apa adanya. Proses sebaiknya tidak melibatkan pengeditan file di bawah folder sistem seperti /usr atau /lib*. Edit /etc atau konfigurasi khusus pengguna di direktori home.
-
Utamakan perangkat lunak bebas jika praktis (dan perangkat lunak yang dipaketkan secara resmi bila memungkinkan). Magazine tetap dapat membahas perangkat lunak non-FOSS untuk digunakan di Fedora, ketika kami mengetahui atau menduga perangkat lunak tersebut sangat populer dan berguna bagi pengguna Fedora. (Google Chrome adalah contoh yang baik.) Namun, jika artikel Anda membahas proses yang umum, gunakan perangkat lunak FOSS.
-
Gunakan libvirt/KVM dalam tips, bukan VirtualBox atau hypervisor lain. Sering kali orang yang datang dari platform lain punya pengalaman dengan VirtualBox. Namun, hypervisor KVM dan libvirt di Fedora adalah FOSS dan merupakan bagian dari platform. Gunakan mereka, tulis tentang mereka, sukai mereka.
-
Kecuali jika perlu, gunakan distro keluarga Fedora. Fedora Magazine mempromosikan Fedora. Kecuali tujuan artikel Anda adalah secara spesifik menjelaskan mekanisme lintas-distro, gunakan instalasi, container, atau distro dalam keluarganya (Fedora, CentOS, RHEL).
-
Perangkat lunak Copr harus disertai peringatan. Sistem build Copr tidak dikelola oleh tim rilis Fedora dan tidak menyediakan build perangkat lunak resmi. Jika Anda membahas perangkat lunak dari Copr, pastikan tidak ada build resmi. Jika tidak, sertakan pernyataan seperti ini: Copr tidak didukung secara resmi oleh infrastruktur Fedora. Gunakan paket dengan risiko Anda sendiri.
-
Hindari bahasa yang eksklusif atau bermasalah. Berikut contoh terminologi yang sebisa mungkin dihindari dalam artikel:
-
blacklist/whitelist — Gunakan allowlist/denylist sebagai gantinya, karena lebih langsung menggambarkan tujuannya.
-
master/slave — Gunakan primary/secondary, primary/replica, active/passive, active/standby, atau padanan lain yang serupa.
-
-
Uji proses Anda. Jika memungkinkan, gunakan VM guest yang baru — atau setidaknya akun pengguna yang benar-benar baru. Jalankan proses Anda dari awal sampai akhir untuk memastikan semuanya berfungsi. Perbaiki, ulangi, dan lakukan lagi.
-
Gunakan gaya penulisan yang benar untuk pihak ketiga. Nama perusahaan, proyek, dan teknologi tidak selalu mengikuti kaidah gaya kata-kata Inggris pada umumnya. Pilih gaya penulisan yang digunakan situs web otoritatif saat Anda ragu. Jika sumber otoritatif menggunakan gaya yang tidak konsisten, gunakan pertimbangan terbaik Anda. Daftar berikut tidak lengkap:
-
Copr alih-alih COPR
-
NVIDIA alih-alih Nvidia atau nVidia
-
Perl alih-alih PERL
-
Red Hat alih-alih Redhat atau RedHat
-
ThinkPad alih-alih Thinkpad
-
Tips gambar dan tangkapan layar
-
Gunakan Fedora Workstation standar yang baru, bukan desktop atau setup pribadi Anda. (Yang terbaik adalah membuat VM dengan instalasi Fedora Workstation yang baru, dan melakukan langkah-langkahnya di sana.) Jika Anda menampilkan sesuatu yang bergantung pada desktop lain, lakukan instalasi baru dan gunakan itu.
-
Atur resolusi layar pada resolusi yang wajar tetapi tidak terlalu tinggi, misalnya 1280x960 atau 1280x800.
-
Jika Anda hanya menampilkan jendela browser, buat ukurannya cukup besar di layar dan ambil tangkapan layar hanya browser-nya. (Petunjuk: Anda bisa memakai aplikasi Screenshot untuk ini!)
-
Jika Anda hanya menampilkan sebuah aplikasi, gunakan ukuran default aplikasi saat mengambil tangkapan layarnya.
-
Upload and use that original media in your article. If the shot is large, like a large browser window, app, or whole screen, choose a medium size thumbnail and let WPEngine handle the conversion.
WPEngine tips
-
Gunakan judul yang sederhana dan relevan. Sebaiknya judul berupa ajakan bertindak, seperti Build a widget using GTK+, atau deskripsi daftar, seperti 5 fun games in Fedora. Judul memengaruhi mesin pencari, dan menghasilkan lebih banyak kunjungan serta peringkat halaman yang lebih tinggi. Itu membantu mendorong trafik ke Magazine.
-
Sediakan gambar unggulan. Lihat informasi di sini untuk tips tentang gambar unggulan. Anda juga boleh meminta editor untuk menetapkan ini untuk Anda. Jika Anda membuat gambar sendiri, cobalah menyesuaikan gaya gambar lain. Gunakan aset yang disediakan di panduan gambar unggulan. Jangan menambahkan font Anda sendiri atau menyimpang dari panduan tersebut.
-
Gunakan praktik SEO yang baik. Gunakan plugin SEO yang disediakan untuk memaksimalkan peringkat pencarian artikel. Usahakan memperoleh penilaian “green” di kotak Publish di kanan atas layar edit artikel Anda. Ikuti pedoman berikut:
-
Masukkan keyword yang bermakna di kotak SEO di bawah artikel Anda. (Sebagian besar artikel sebaiknya tidak menggunakan Fedora.)
-
Jika Snippet tidak memberikan pengantar atau ringkasan yang efektif pada contoh hasil pencarian, tulis ulang.
-
Jangan merasa harus menghilangkan setiap peringatan. Penilaian “green” secara keseluruhan adalah satu-satunya tujuan.
-
-
Use the Edit as HTML option when pasting into preformatted blocks. Current versions of WPEngine are known to strip leading hash marks (#) and leading whitespace when content is pasted into preformatted blocks. Some non-alphanumeric characters may also get garbled (&, <, >, etc.). Using the Edit as HTML option (listed under the vertical ellipsis) prior to pasting content into the block seems to workaround this problem. Be sure to paste your content between the <pre> tags and do not overwrite them. After pasting your content, switch back to visual mode by using the Edit visually option to see a better representation of what the final result will look like to the reader.
Petunjuk lain
Punya ide untuk penulisan yang lebih baik? Diskusikan dengan para editor di kanal Matrix #magazine:fedoraproject.org di chat.fedoraproject.org.
Want to help? Learn how to contribute to Fedora Docs ›