Kubernetesのドキュメントを翻訳する
このページでは、Kubernetesドキュメントにおける日本語翻訳の方針について説明します。
ドキュメントを日本語に翻訳するまでの流れ
翻訳を行うための基本的な流れについて説明します。不明点がある場合はKubernetes公式Slackの#kubernetes-docs-jaチャンネルにてお気軽にご質問ください。
前提知識
翻訳作業は全てGitHubのIssueによって管理されています。翻訳作業を行いたい場合は、Issueの一覧をまず最初にご確認ください。
また、Kubernetes傘下のリポジトリではCLAと呼ばれる同意書に署名しないと、Pull Requestをマージすることができません。詳しくは英語のドキュメントや、Qiitaに有志の方が書いてくださった日本語のまとめをご覧ください。
翻訳を始めるまで
翻訳を希望するページのIssueが存在しない場合
- こちらのサンプルに従う形でIssueを作成する
- 自分自身を翻訳作業に割り当てたい場合は、Issueのメッセージまたはコメントに
/assignと書く - 新規ページを翻訳する場合のステップに進む
不明点がある場合はKubernetes公式Slackの#kubernetes-docs-jaチャンネルにてお気軽にご質問ください。
翻訳を希望するページのIssueが存在する場合
- 自分自身を翻訳作業に割り当てるために、Issueのコメントに
/assignと書く - 新規ページを翻訳する場合のステップに進む
Pull Requestを送るまで
新規ページを翻訳する場合の手順
kubernetes/websiteリポジトリをフォークするmainから任意の名前でブランチを作成するcontent/enのディレクトリから必要なファイルをcontent/jaにコピーし、翻訳するmainブランチに向けてPull Requestを作成する
既存のページの誤字脱字や古い記述を修正する場合の手順
kubernetes/websiteリポジトリをフォークするmainから任意の名前でブランチを作成するcontent/jaのディレクトリから必要なファイルを編集するmainブランチに向けてPull Requestを作成する
翻訳スタイルガイド
基本方針
- 本文を、敬体(ですます調)で統一
- 特に、「〜になります」「〜となります」という表現は「〜です」の方が適切な場合が多いため注意
- 句読点は「、」と「。」を使用
- 漢字、ひらがな、カタカナは全角で表記
- 数字とアルファベットは半角で表記
- 記号類は感嘆符「！」と疑問符「？」のみ全角、それ以外は半角で表記
- 英単語と日本語の間に半角スペースは不要
- 日本語文では、文章の途中で改行を行わない。句点「。」で改行する
- メタデータの
reviewerの項目は削除する - すでに日本語訳が存在するページにリンクを張る場合は、
/ja/を含めたURLを使用する- 例:
/path/to/page/ではなく、/ja/path/to/page/を使用する
- 例:
用語の表記
Kubernetesのリソース名や技術用語などは、原則としてそのままの表記を使用します。 例えば、PodやService、Deploymentなどは翻訳せずにそのまま表記してください。
ただし、ノード(Node)に関しては明確にKubernetesとしてのNodeリソース(例: kind: Nodeやkubectl get nodes)を指していないのであれば、「ノード」と表記してください。
またこれらの単語は、複数形ではなく単数形を用います。 例えば、原文に"pods"と表記されている場合でも、日本語訳では"Pod"と表記してください。
頻出表記(日本語)
| よくある表記 | あるべき形 |
|---|---|
| 〜ので、〜から、〜だから | 〜のため 、〜ため |
| (あいうえお。) | (あいうえお)。 |
| 〇,〇,〇 | 〇、〇、〇(※列挙はすべて読点で統一) |
長音の有無
カタカナ語に長音を付与するかどうかは、以下の原則に従ってください。
- -er、-or、-ar、-cy、-gyで終わる単語は長音を付与する
- 例: 「クラスター」「セレクター」「サイドカー」「ポリシー」「トポロジー」
- -ear、-eer、-re、-ty、-dy、-ryで終わる単語は長音を付与しない
- 例: 「クリア」「エンジニア」「アーキテクチャ」「セキュリティ」「スタディ」「ディレクトリ」
ただし、「コンテナ」は例外的に長音を付与しないこととします。
この原則を作成するにあたって、mozilla-japan/translation Editorial Guideline#カタカナ語の表記を参考にしました。
その他の表記
その他の表記については、以下の表を参考にしてください。
| 英語 | 日本語 |
|---|---|
| interface | インターフェース |
| proxy | プロキシ |
| quota | クォータ |
| stacked | 積層 |
cron jobの訳し方に関して
混同を避けるため、cron jobはcronジョブと訳し、CronJobはリソース名としてそのまま表記します。 cron「の」ジョブは、「の」が続く事による解釈の難から基本的にはつけないものとします。
その他基本方針など
- 意訳と直訳で迷った場合は「直訳」で訳す
- 訳で難しい・わからないと感じたらSlackの
#kubernetes-docs-jaで相談する - できることを挙手制で、できないときは早めに報告
アップストリームのコントリビューター
SIG Docsでは、英語のソースに対するアップストリームへのコントリビュートや誤りの訂正を歓迎しています。