Penulisan: menulis dan menyunting topik
Sebelum Anda menulis
- Baca aturan gaya dan
spec/conventions.mddi akar repositori. - Periksa
spec/structure.mddi akar repositori untuk melihat di mana topik itu cocok dan nomor apa yang seharusnya ia miliki.
Menulis topik baru
- Pilih bagian dan nomor desimal kosong berikutnya di bagian itu. Penomoran berkesinambungan, jadi topik baru biasanya mengambil nomor setelah yang terakhir di bagiannya.
- Buat
locales/en-gb-oxendict/topics/PP-CC-slug.md(awalan yang diisi nol dan dipisah tanda hubung, misalnya02-01-...) dari templat topik. Tulis dalam ejaan Oxford (lihatspec/oxford-spelling.md); jangan pernah menyunting tiga lokal lainnya secara langsung. - Tulis sesuai templat. Setiap topik isi membutuhkan semua bagiannya: ikhtisar, prinsip kunci, rekomendasi, pertukaran (dengan tabel), pertanyaan diskusi, lensa sektor (startup, usaha kecil, perusahaan, pemerintah), contoh (satu perusahaan dan satu pemerintah), kasus bisnis, anti-pola, model kematangan lima tingkat, gagasan diskusi, poin penting, dan rujukan.
- Sebutkan jalur manipulasi. Setiap keluarga metrik membutuhkan jawaban eksplisit atas “bagaimana tim membuat angka ini tampak baik tanpa memperbaiki apa yang diukurnya, dan pengaman apa yang menangkapnya” (lihat topik 1.2).
- Definisikan istilah pada penggunaan pertama. Tambahkan tautan Wikipedia untuk konsep kunci pada sebutan pertama, hanya dalam prosa.
- Rujuk silang topik terkait dengan nomor desimal, misalnya “(topik 2.1).”
- Tambahkan topik ke
spec/structure.md. - Jika pengantar bagian (N.0) mendaftar topiknya, tambahkan butir di sana.
- Jalankan
python3 tools/localize.pyuntuk menurunkan topik keen-001,en-gb, danen-us. - Jalankan
just nav, lalujust test.
Menyunting topik yang ada
- Pertahankan urutan bagian dan judul. Pengujian memeriksa bahwa topik isi masih memiliki setiap bagian yang diperlukan.
- Pertahankan definisi sebaris, tautan Wikipedia, tabel, dan daftar rujukan kecuali penyuntingan itu memang tentang hal-hal tersebut.
- Jangan memasukkan em-dash atau ungkapan terlarang. Jika Anda menyusun ulang, tulis ulang alih-alih menyelipkan tanda pisah.
- Jalankan
python3 tools/localize.pysetelahnya untuk menurunkan ulangen-001,en-gb, danen-usdari sumberen-gb-oxendictyang telah disunting.
Mengganti nama atau menomori ulang
- Ganti nama berkas di
locales/en-gb-oxendict/, perbarui judul# N.M Title, perbaruispec/structure.md, dan perbarui setiap rujukan silang yang menunjuk ke nomor lama. - Jalankan
python3 tools/localize.pyuntuk mengganti nama berkas di tiga lokal lainnya juga (ia menurunkan keempatnya dari jalur relatif yang sama). - Jalankan
just navdanjust test. Pengujian akan menandai ketidakcocokan antara H1 dan nama berkas, celah penomoran, lokal yang menyimpang dari sumber, atau tautan rusak.
Pengingat nada
Tulislah seperti rekan berpengalaman yang ingin pembacanya berhasil. Hangat, sederhana, langsung, dan berguna. Kalimat pendek. Tanpa pengisi.