国際化
カイア・ドックスは、世界中の観客がアクセスできることを 目指している。 私たちは、ドキュメンテーションの翻訳と改善のためのコミュニティからの貢献に感謝しています。
使用可能言語
Kaia Docsは現在以下の言語に対応しています:
カイヤドックス翻訳の仕組み
- 英語がソース言語で、GitHubで管理されています。
- 英語のコンテンツが更新されると、その変更が翻訳管理プラットフォームであるCrowdinに同期されます。
- 機械翻訳(MT)は、一部の言語(日本語、簡体字中国語、繁体字中国語、韓国語、ベトナム語)にお いて、新しいコンテンツへの即時アクセスを提供するために使用されています。
- 手作業によるレビューと改善:コミュニティの貢献者とモデレーターがCrowdinの翻訳をレビューし、改善します。
- 自動更新:翻訳が承認されると、CrowdinはKaia DocsのGitHubリポジトリにプルリクエスト(PR)を作成します。 マージされると、多言語ドキュメントサイトが更新される。
Crowdinで翻訳を提供する方法
Kaia Docsの翻訳はすべて、共同翻訳プラットフォームであるCrowdinを通じて管理されています。
- Crowdin上のKaia-Docsプロジェクトに移動してください。
- Crowdinアカウントを作成する(すでにお持ちの場合はログインしてください)。
- プロジェクト・ページから貢献したい言語を選択してください。 もしあなたの言語がリストにない場合は、GitHubでissueを発行することで
content-translation
ラベルを使って新しい言語をリクエストすることができます。 - 選択した言語の翻訳者チームに参加してください。 プロジェクトマネージャーの承認が必 要な場合があります。
- 翻訳またはレビューしたいファイルを選んでください。
- 翻訳を開始する: Crowdinオンラインエディタを使用してください。
- ソース文字列の新しい翻訳を入力します。
- 既存の翻訳の改善を提案する。
- 他の人の提案に投票する。
- 質問がある場合、または特定のストリングについて議論したい場合は、コメントを残してください。
- クイックQAチェックリスト(レビュアー):.
- ✔️ コードスニペット、コマンド、変数名、ブランド名など、翻訳不可能なコンテンツは英語のままにしておく(Crowdinの「Hide Visible」機能を使う)。
- ✔️ エディターの "Terms "タブをクリックしてKaia Terminologiesに準拠する。
- ✔️ メニュー項目、見出し、タイトルを中心にわかりやすく。
詳しいエディタの使い方については、公式のCrowdin documentationを参照してください。
翻訳の役割
- 翻訳者:Crowdinでプロジェクトに参加すれば、誰でもファイル内の文字列の翻訳を提案することができます。 正確さと明瞭さを重視する。
- レビュアー(QA):経験豊富な翻訳者には、提案された翻訳の言語的品質保証(QA)をお願いすることがあります。 これには、一貫性、用語の順守、明確さ、翻訳不可能な要素(コード・スニペットなど)を正しく扱っているかどうかのチェックが含まれる。 レビュアーは言語的な質に注目するが、最終的な承認ステップは行わない。
- モデレーター: Crowdin内でQAフィードバックを確認し、翻訳の最終承認を行うプロジェクトのメンテナンス担当者。 承認された翻訳は、Crowdinが使用する翻訳メモリにも貢献します。
Crowdinのファイルを理解する
CrowdinでKaia Docsプロジェクトをブラウズすると、翻訳用に整理されたさまざまなファイルやフォルダが表示されます。 それぞれの内容を理解することで、あなたの翻訳がKaia Docsサイトのどこに表示されるかを知ることができます:
-
docs
:このフォルダには、Markdown(.md
または.mdx
ファイル)で記述されたKaiaドキュメントページのメインコンテンツが含まれています。 ここでファイルを翻訳すると、サイトのメインコンテンツにある記事、ガイド、チュートリアルが直接翻訳されます。 -
i18n/ja/code.json
:ウェブサイトのユーザーインターフェイス(UI)コードに直接埋め込まれたテキスト文字列が含まれ、しばしば特定の翻訳関数やコンポーネント(<Translate>
のような)を使います。 これには、ラベル、ボタン、カスタム機能内のメッセージ、他の特定のファイルでカバーされていないサイトのテーマの部分などが含まれます。 あなたがここで翻訳した内容は、サイトのインターフェイス要素全体に表示されます。 -
i18n/ja/docusaurus-plugin-content-docs/current.json
:ドキュメントの構造自体に関連するラベルの翻訳を保持します。 これには主に、サイドバーのカテゴリー名や、ドキュメントシステムによって自動的に生成されるその他のナビゲーション要素が含まれます。 これらを翻訳することで、ユーザーがそれぞれの言語でドキュメントセクションをナビゲートできるようになります。 -
i18n/ja/docusaurus-theme-classic/footer.json
:各ページの下にあるウェブサイトのフッターエリアにあるすべての翻訳可能なテキストが含まれています。 これには通常、著作権表示、リンク、その他のフッター固有のテキストが含まれます。 -
i18n/ja/docusaurus-theme-classic/navbar.json
:ページ上部にあるウェブサイトのメインナビゲーションバーにあるすべての翻訳可能なテキストが含まれています。 これには、リンク、ドロップダウンメニュー、その他のナビゲーション要素のラベルが含まれます。
機械翻訳(MT)ポリシー
世界中のユーザーに新しいコンテンツや更新されたコンテンツへの迅速なアクセスを提供するため、上記のリストに示すように、特定の言語については機械翻訳(MT)を利用しています。
- 動作原理: 英語のドキュメントが更新されると、MTが自動的に初期翻訳を提供します。 その後、メンテナーのレビュー後、Kaia Docsウェブサイトに同期されます。
- 免責事項: 機械翻訳(MT)を主に使用して翻訳されたページには、コンテンツに不正確な部分が含まれる可能性があることをユーザーに通知し、Crowdinを通じて改善にご協力いただくよう促す免責事項が表示されます。
- あなたの貢献が重要です: MTであっても、コミュニティからの貢献は、正確さ、文脈、自然な言い回しを改善するために不可欠です。
ソース・コンテンツ更新の影響
我々のドキュメントは常に進化している。 GitHubリポジトリの英語ソースが更新されると、Crowdinの対応する文字列も更新されます。
- 翻訳リセット:この同期プロセスは、_変更された文字列_に対する既存の翻訳がリセットされることを意味します(新しい英語テキストまたは新しい機械翻訳のいずれか)。
- なぜですか? これにより、翻訳されたドキュメントが最新の英語ソースの構造と核心的な情報を正確に反映するように保証されます。
- 貢献の価値: 個々の文字列はリセットされるかもしれませんが、あなたの貢献は、その時点*でのドキュメンテーションの正確さと品質を保証し、全体的なローカライゼーションを洗練させるのに役立つため、依然として非常に価値があります。
ディスカッション&コミュニティ
- Crowdin DiscussionsまたはプロジェクトのGitHub Discussionsに参加して、貢献者仲間やメンテナーとつながりましょう。
行動規範
すべてのコミュニティメンバーに敬意を払ってください。 プロジェクトマネージャーは、必要に応じて、不快なコンテンツを削除し、投稿へのアクセス権を剥奪する権利を留保します。 当社の行動規範を遵守してください。