Kubernetesのドキュメントを翻訳する

このページでは、Kubernetesドキュメントにおける日本語翻訳の方針について説明します。

ドキュメントを日本語に翻訳するまでの流れ

翻訳を行うための基本的な流れについて説明します。不明点がある場合はKubernetes公式Slackの#kubernetes-docs-jaチャンネルにてお気軽にご質問ください。

前提知識

翻訳作業は全てGitHubのIssueによって管理されています。翻訳作業を行いたい場合は、Issueの一覧をまず最初にご確認ください。

また、Kubernetes傘下のリポジトリではCLAと呼ばれる同意書に署名しないと、Pull Requestをマージすることができません。詳しくは英語のドキュメントや、Qiitaに有志の方が書いてくださった日本語のまとめをご覧ください。

翻訳を始めるまで

翻訳を希望するページのIssueが存在しない場合

1. こちらのサンプルに従う形でIssueを作成する
2. 自分自身を翻訳作業に割り当てたい場合は、Issueのメッセージまたはコメントに/assignと書く
3. 新規ページを翻訳する場合のステップに進む

不明点がある場合はKubernetes公式Slackの#kubernetes-docs-jaチャンネルにてお気軽にご質問ください。

翻訳を希望するページのIssueが存在する場合

1. 自分自身を翻訳作業に割り当てるために、Issueのコメントに/assignと書く
2. 新規ページを翻訳する場合のステップに進む

Pull Requestを送るまで

新規ページを翻訳する場合の手順

1. kubernetes/websiteリポジトリをフォークする
2. mainから任意の名前でブランチを作成する
3. content/enのディレクトリから必要なファイルをcontent/jaにコピーし、翻訳する
4. mainブランチに向けてPull Requestを作成する

既存のページの誤字脱字や古い記述を修正する場合の手順

1. kubernetes/websiteリポジトリをフォークする
2. mainから任意の名前でブランチを作成する
3. content/jaのディレクトリから必要なファイルを編集する
4. mainブランチに向けてPull Requestを作成する

翻訳スタイルガイド

基本方針

• 本文を、敬体(ですます調)で統一
  • 特に、「〜になります」「〜となります」という表現は「〜です」の方が適切な場合が多いため注意
• 句読点は「、」と「。」を使用
• 漢字、ひらがな、カタカナは全角で表記
• 数字とアルファベットは半角で表記
• 記号類は感嘆符「！」と疑問符「？」のみ全角、それ以外は半角で表記
• 英単語と日本語の間に半角スペースは不要
  • 例: Kubernetesクラスター
  • カッコ()の前後にも半角スペースは不要
• 日本語文では、文章の途中で改行を行わない。句点「。」もしくは行末のコロン:で改行する
• コロン:の後には、半角スペースを入れる
  • 例外的に行末のコロンの後は半角スペースは不要
• メタデータのreviewersの項目は削除する
• すでに日本語訳が存在するページにリンクを張る場合は、/ja/を含めたURLを使用する
  • 例: /path/to/page/ではなく、/ja/path/to/page/を使用する

用語の表記

Kubernetesのリソース名や技術用語などは、原則としてそのままの表記を使用します。 例えば、PodやService、Deploymentなどは翻訳せずにそのまま表記してください。

ただし、ノード(Node)に関してはKubernetesとしてのNodeリソース(例: kind: Nodeやkubectl get nodes、Nodeコントローラーなど)を指していないのであれば、「ノード」と表記してください。

またこれらの単語は、複数形ではなく単数形を用います。 例えば、原文に"pods"と表記されている場合でも、日本語訳では"Pod"と表記してください。

特定の用語がKubernetes固有の技術用語であるかどうかについて迷った時は、次の判断フローを参考にしてください。

1. APIリソースの一覧または標準化用語集に対象の用語が掲載されている場合は、掲載されている用語で表記します。
2. その他のKubernetesに関連する用語については、固有名詞と判断できるものは原則アルファベットで表記します。
3. 新しく用語を日本語として翻訳する際は、レビュアーやローカライゼーションチームに意見を聞いてください。

ローカライゼーションチームは、あなたのコメントを歓迎します！

頻出表記(日本語)

よくある表記	あるべき形
〜ので、〜から、〜だから	〜のため 、〜ため
(あいうえお。)	(あいうえお)。
〇,〇,〇	〇、〇、〇(※列挙はすべて読点で統一)

長音の有無

カタカナ語に長音を付与するかどうかは、以下の原則に従ってください。

• -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では、英語のソースに対するアップストリームへのコントリビュートや誤りの訂正を歓迎しています。