Translations
Terjemahan otomatis tersedia sebagai add-on berbayar untuk paket Growth, Pro, dan Enterprise. Silakan hubungi sales untuk informasi lebih lanjut.
Ikhtisar
Anda dapat menerjemahkan dokumentasi Anda secara otomatis ke dalam beberapa bahasa sambil mempertahankan struktur, format, dan tautan dengan AI. Terjemahan terintegrasi dengan fitur languages, memungkinkan pembaca untuk beralih antara bahasa yang tersedia dalam dokumentasi Anda.
Prasyarat
- Anda harus memiliki paket Growth, Pro, atau Enterprise dan add-on terjemahan untuk bahasa target Anda.
- Anda harus menggunakan GitHub sebagai penyedia repositori untuk konten dokumentasi Anda.
- Dokumentasi Anda harus menggunakan bahasa Inggris sebagai bahasa dasar.
- Anda harus memiliki
docs.json
file yang valid di repositori Anda. - Semua konten yang akan diterjemahkan harus menggunakan
MDX
format yang valid. SetiapMDX
yang tidak valid akan menyebabkan terjemahan gagal.
Memulai
Mulailah dengan terjemahan lengkap dokumentasi Anda ke masing-masing bahasa pilihan Anda. Pendekatan ini memastikan cakupan lengkap dalam setiap bahasa dan secara otomatis memperbarui file docs.json
Anda.
Anda dapat memulai terjemahan lengkap dari halaman terjemahan di dashboard Anda.
- Pilih Start translation.
- Pilih bahasa pertama yang ingin Anda terjemahkan konten Anda ke dalamnya dan kemudian pilih Start translation.
- Proses terjemahan akan membuat cabang baru dan pull request di repositori proyek Mintlify Anda dengan konten yang diterjemahkan. Set dokumentasi yang lebih besar mungkin membutuhkan waktu lebih lama untuk diproses.
- Tinjau pull request dan gabungkan.
- Ulangi proses untuk setiap bahasa yang ingin Anda terjemahkan.
Terjemahan otomatis disimpan di bawah direktori yang diberi nama sesuai language code yang telah Anda pilih.
Nama direktori kustom untuk terjemahan tidak didukung saat ini.
Terjemahan Berkelanjutan
Setelah menambahkan terjemahan ke file docs.json
Anda, setiap perubahan di masa depan pada dokumentasi Anda akan diterjemahkan secara otomatis selama Anda mempertahankan langganan add-on terjemahan untuk bahasa yang telah Anda konfigurasi.
Proses terjemahan berkelanjutan mengikuti urutan berikut:
- Seorang anggota organisasi Anda membuat perubahan pada dokumentasi di repositori Anda.
- Ketika perubahan di-push atau digabungkan ke cabang utama Anda, pekerjaan terjemahan berkelanjutan dipicu.
- Pekerjaan terjemahan memperbarui, menghapus, atau membuat file yang diperlukan dalam semua bahasa yang dilanggan berdasarkan file
docs.json
Anda. - Pekerjaan terjemahan membuat cabang terpisah dan pull request yang berisi perubahan terjemahan untuk ditinjau oleh Anda.
Mintlify tidak akan pernah mempublikasikan terjemahan ke produksi secara otomatis. Anda harus meninjau dan menggabungkan setiap pull request terjemahan sebelum perubahan tersebut aktif.
Pekerjaan terjemahan otomatis tidak menangani perubahan manual pada file yang dilokalisasi atau pohon navigasi docs.json
dengan baik. Lakukan semua perubahan dalam konten bahasa Inggris Anda dan biarkan layanan terjemahan mengelola versi yang dilokalisasi.
Kami menyarankan untuk segera meninjau dan menggabungkan pull request terjemahan sehingga lokalisasi Anda tetap sinkron.
Menulis konten untuk diterjemahkan
Untuk membuat dokumentasi Anda lebih mudah diterjemahkan dan lebih mudah dibaca dalam bahasa Inggris, hindari pola umum berikut:
- Bertele-tele: Kalimat yang berlebihan lebih sulit dipahami dan diterjemahkan.
- Hindari: “In order to be able to successfully complete the installation process…”
- Lebih baik: “To install the software…”
- Kalimat pasif: Kalimat pasif membuat tidak jelas siapa yang melakukan suatu tindakan.
- Hindari: “The configuration file should be updated by the administrator.”
- Lebih baik: “The administrator should update the configuration file.”
- Kalimat negatif: Beri tahu orang apa yang harus dilakukan daripada apa yang tidak boleh dilakukan.
- Hindari: “Don’t forget to not skip the configuration step.”
- Lebih baik: “Remember to complete the configuration step.”
- Kata ganti: Kata-kata seperti “it,” “this,” dan “that” dapat tidak jelas tentang apa yang mereka rujuk, terutama jika sebuah kalimat menggunakan banyak kata ganti. Gunakan kata benda spesifik sebagai gantinya.
- Hindari: “Configure the database connection. After you do this, it will work properly.”
- Lebih baik: “Configure the database connection. After you configure the connection, the database will work properly.”
- Hindari: “When you configure it, make sure it connects to them properly so they can communicate with each other.”
- Lebih baik: “When you configure the database, make sure the database connects to the servers properly so the servers can communicate with each other.”
- Jangkar tautan yang ambigu: Jelaskan dengan akurat ke mana sebuah tautan mengarah dan hindari jangkar tautan yang ambigu seperti
Click here
. Jika memungkinkan, gunakan judul yang tepat dari halaman atau sumber daya yang dituju oleh tautan.- Hindari: “Klik
[here](path/to/getting-started-guide)
untuk mempelajari lebih lanjut tentang proses pengaturan.” - Lebih baik: “Pelajari lebih lanjut tentang proses pengaturan di
[getting started guide](path/to/getting-started-guide)
.”
- Hindari: “Klik
- Nominalisasi: Kata kerja atau kata sifat yang diubah menjadi kata benda, sering berakhiran -ion, -ment, atau -ness. Gunakan kata kerja aktif sebagai gantinya.
- Hindari: “The configuration of your navigation requires a valid
docs.json
.” - Lebih baik: “You must have a valid
docs.json
to configure your navigation.”
- Hindari: “The configuration of your navigation requires a valid
- Modifier bertumpuk: Beberapa kata benda atau kata sifat yang dikelompokkan bersama menciptakan ambiguitas tentang hubungan antar kata.
- Hindari: “API endpoint configuration management system.”
- Lebih baik: “System for managing API endpoint configuration.”
- Frasa preposisi: Rantai panjang frasa preposisi (frasa yang dimulai dengan kata-kata seperti “of,” “in,” “with,” “on”) menciptakan kalimat yang kompleks.
- Hindari: “The selections of the settings in the admin panel of the application.”
- Lebih baik: “Pengaturan aplikasi di panel admin.”
- Kata kerja bantu modal: Kata-kata seperti “mungkin,” “bisa,” “akan,” dan “seharusnya” yang mengekspresikan kemungkinan atau kewajiban dapat menjadi tidak jelas. Gunakan perintah langsung sebagai gantinya.
- Hindari: “Anda mungkin ingin mempertimbangkan untuk memperbarui konfigurasi, yang berpotensi dapat meningkatkan kinerja.”
- Lebih baik: “Perbarui konfigurasi untuk meningkatkan kinerja.”
- Mood non-indikatif: Gunakan pernyataan langsung alih-alih mood subjunktif atau kondisional.
- Hindari: “Jika Anda mengkonfigurasi pengaturan, aplikasi akan berfungsi dengan benar.”
- Lebih baik: “Konfigurasikan pengaturan agar aplikasi berfungsi dengan benar.”
- Jamak yang tidak terlihat: Perjelas apakah Anda merujuk pada item tunggal atau jamak.
- Hindari: “Data pengguna” (Bisa jadi data dari satu pengguna atau beberapa pengguna)
- Lebih baik: “Data dari pengguna individu” atau “Data dari semua pengguna”
- Kata-kata spesifik gender: Beberapa bahasa memiliki aturan gender yang tidak diterjemahkan secara langsung.
- Hindari: “Ketika pengguna masuk, dia harus melihat dashboardnya.”
- Lebih baik: “Setelah masuk, pengguna melihat dashboard.”
- Akronim: Definisikan setiap akronim pada penggunaan pertama untuk memberikan konteks.
- Hindari: “Gunakan operasi CRUD.”
- Lebih baik: “Gunakan operasi CRUD (Create, Read, Update, Delete).”
- Slang, lelucon, atau contoh spesifik budaya: Gunakan bahasa yang mudah diterjemahkan.
- Hindari: “Jangan khawatir, kami mendukung Anda.”
- Lebih baik: “Kami menyediakan dukungan untuk proses ini.”
- Hindari: “Fitur ini sangat luar biasa.”
- Lebih baik: “Fitur ini memberikan hasil yang sangat baik.”