Gaya Microsoft Learn dan mulai cepat suara

Mulai cepat ini adalah panduan singkat untuk menulis konten teknis untuk publikasi di Microsoft Learn. Panduan ini berlaku apakah Anda membuat dokumentasi baru atau memperbarui dokumentasi yang sudah ada.

Praktik terbaik:

• Periksa ejaan dan tata bahasa di artikel Anda, meskipun Anda harus menyalin dan menempelkan ke Microsoft Word untuk memeriksanya.
• Gunakan suara santai dan ramah—seperti Anda berbicara dengan orang lain satu per satu.
• Gunakan kalimat sederhana. Kalimat yang mudah dibaca berarti pembaca dapat dengan cepat menggunakan panduan yang Anda bagikan.

Menggunakan prinsip suara Microsoft

Kami beraspirasi untuk mengikuti prinsip-prinsip ini ketika kami menulis konten teknis untuk Microsoft Learn. Kita mungkin tidak selalu sampai di sana, tapi kita harus terus mencoba!

• Fokus pada niat: Pelanggan memiliki tujuan khusus dalam pikiran ketika mereka berkonsultasi dengan dokumentasi kami. Sebelum Anda mulai menulis, tentukan dengan jelas siapa pelanggan dan tugas apa yang dia coba lakukan. Kemudian, tulis artikel Anda untuk membantu pelanggan tertentu melakukan tugas tertentu tersebut.
• Gunakan kata-kata sehari-hari: Cobalah untuk menggunakan bahasa alami, kata-kata yang digunakan pelanggan Anda. Menjadi kurang formal tetapi tidak kurang teknis. Berikan contoh yang menjelaskan konsep baru.
• Tulis dengan ringkas: Jangan buang-buang kata. Jadilah penegas dan jangan gunakan kata tambahan atau banyak kualifikasi. Jaga agar kalimat tetap pendek dan ringkas. Tetap fokus pada artikel Anda. Jika tugas memiliki kualifikasi, letakkan di awal kalimat atau paragraf. Selain itu, pertahankan jumlah catatan minimal. Gunakan cuplikan layar saat dapat menyimpan kata- kata.
• Buat artikel Anda mudah dipindai: Letakkan hal-hal terpenting terlebih dahulu. Gunakan bagian untuk memotong prosedur panjang ke dalam grup langkah yang lebih mudah dikelola. (Prosedur dengan lebih dari 12 langkah mungkin terlalu panjang.) Gunakan cuplikan layar saat menambahkan kejelasan.
• Perlihatkan empati: Gunakan nada yang mendukung dalam artikel, dan minimalkan penafian. Jujur memanggil area yang akan membuat frustrasi pelanggan. Pastikan artikel berfokus pada hal yang penting bagi pelanggan; jangan hanya memberikan kuliah teknis.

Pertimbangkan pelokalan dan terjemahan mesin

Artikel teknis kami diterjemahkan ke dalam beberapa bahasa, dan beberapa dimodifikasi untuk pasar atau geografi tertentu. Orang mungkin juga menggunakan terjemahan mesin di web untuk membaca artikel teknis. Jadi, ingatlah panduan berikut saat Anda menulis:

• Pastikan artikel tidak berisi kesalahan tata bahasa, ejaan, atau tanda baca: Ini adalah sesuatu yang harus kita lakukan secara umum. Beberapa editor Markdown (seperti MarkdownPad 2.0) memiliki pemeriksa ejaan dasar, tetapi ini adalah praktik yang baik untuk menempelkan konten HTML yang dirender dari artikel ke Word, yang memiliki pemeriksa ejaan dan tata bahasa yang lebih kuat.
• Buat kalimat Anda sesingkat mungkin: Kalimat majemuk atau rantai klausul menyulitkan terjemahan. Pisahkan kalimat jika Anda dapat melakukannya tanpa terlalu berlebihan atau terdengar aneh. Kami juga tidak ingin artikel ditulis dalam bahasa yang tidak wajar.
• Gunakan konstruksi kalimat sederhana dan konsisten: Konsistensi lebih baik untuk terjemahan. Hindari tanda kurung dan kesampingkan, dan memiliki subjek mendekati awal kalimat sesempurna mungkin. Lihat beberapa artikel yang diterbitkan. Jika artikel memiliki gaya yang ramah dan mudah dibaca, gunakan sebagai model.
• Gunakan kata dan kapitalisasi yang konsisten: Sekali lagi, konsistensi adalah kunci. Jangan memanfaatkan kata jika tidak di awal kalimat atau itu bukan kata benda yang tepat.
• Sertakan "kata-kata kecil": Kata-kata yang kami anggap kecil dan tidak penting dalam bahasa Inggris karena dipahami untuk konteks (seperti "a," "the," "that," dan "is") sangat penting untuk terjemahan mesin. Pastikan untuk menyertakannya.

Masalah gaya dan suara lain yang harus diwaspadai

• Jangan memecah langkah-langkah dengan komentar atau kesampingkan.
• Untuk langkah-langkah yang menyertakan cuplikan kode, masukkan informasi tambahan tentang langkah ke dalam kode sebagai komentar. Ini mengurangi jumlah teks yang harus dibaca orang. Informasi utama akan disalin ke dalam proyek kode untuk mengingatkan orang tentang apa yang dilakukan kode ketika mereka merujuknya nanti.
• Gunakan kasus kalimat untuk semua judul dan judul.
• Gunakan "masuk" dan bukan "masuk."
• Untuk panduan selengkapnya, lihat Panduan Gaya Penulisan Microsoft.

Dokumentasi yang dilokalkan

• Jika Anda berkontribusi pada dokumentasi yang dilokalkan, lihat referensi globalisasi.
• Untuk panduan pelokalan, informasi tentang gaya bahasa dan penggunaan dalam publikasi teknis, dan informasi tentang format data khusus pasar, unduh panduan gaya dalam bahasa Anda.
• Kunjungi Terminologi Microsoft untuk mencari terminologi yang disetujui khusus produk atau untuk mengunduh Koleksi Terminologi Microsoft dalam bahasa Anda.
• Untuk mempelajari selengkapnya tentang pelokalan, lihat "Komunikasi global" di Panduan Gaya Penulisan Microsoft.

Catatan

Sebagian besar dokumentasi yang dilokalkan tidak menawarkan kemampuan untuk mengedit atau memberikan umpan balik melalui GitHub. Untuk memberikan umpan balik tentang konten yang dilokalkan, gunakan https://aka.ms/provide-feedback formulir.