Skip to content

[ja] Update content/ja/docs/contribute/localization.md #52964

@t-inu

Description

@t-inu

This is a Feature Request

What would you like to be added

Proposed changes to the Japanese translation guidelines

  • Replace the issue creation sample with one that includes the /area localization command
  • Provide explicit instructions regarding spacing around backticks (`)
  • Remove the instruction stating that translated documents should include /ja in internal links
  • Add a rule requiring the configuration of explicit heading IDs for page headings needing translation
  • Document specific considerations for translating blog articles
  • Document the fundamental policy for handling Katakana terms

As this detail relates to an update for the Japanese page, it is included in Japanese at the end of this post.

Kubernetesのドキュメントを翻訳する」のガイドラインを、次のように更新します。
詳細は、この投稿の最後に記載します。

  • Issue作成時のサンプルを、/area localizationも含んだものにする
  • バッククォートの前後を空けるかどうかの説明を記載する
  • ドキュメント内のリンクに/jaを含める旨の記述を削除する
  • ページ内の見出しには、見出しIDを設定することを記載する
  • ブログ記事を翻訳する際の留意事項を記載する
  • カタカナ語についての基本方針を記載する

Why is this needed

To clarify the localization policy for Japanese.

Comments

/area localization
/language ja
/assign

@kubernetes/sig-docs-ja-reviews
意見や要望などありましたら、コメントをお願いします。


以下は詳細です。

Issue作成時のサンプルを、/area localizationも含んだものにする

area/localizationラベルは投稿者側で付与できるため、最初から記載されているサンプルに差し替えます。

バッククォートの前後を空けるかどうかの説明を記載する

バッククォートで囲われた文字列の、内側も外側も英単語の場合、詰めてしまうケースがよくあります。
バッククォートは、実際には表示されない特殊記号であるため、詰めると英単語の間に空白がなくなってしまうことになります。
そこで、例もつけて説明を記載します。

  • バッククォート`で囲まれた英単語と、その前後の英単語の間には半角スペースが必要
    • 例: これは`default` ServiceAccountです(前は詰めて後ろは空ける)

ドキュメント内のリンクに/jaを含める旨の記述を削除する

本ドキュメント内のページへのリンクは、HTMLへの変換時に、対象の日本語ページの有無が自動判別され、必要に応じて/jaが付与される仕様に変更されました。
手動での記載は不要となったことから、/jaを含めるという記述は削除します。
また、既存の日本語ページ内のリンクでは/jaの有無が混在していることや、本件の事情に詳しくない人にとっては、追加が必要なのかどうか迷う可能性があるため、以下を記載します。

  • 本ドキュメント内のページへのリンクは、日本語ページが存在していても、URLに/jaの追加は不要(HTMLへの変換時に自動判別されるようになったため)
    • 既存の日本語ページで/jaが記載されている場合は、ページの最新化の際に削除する

ページ内の見出しには、見出しIDを設定することを記載する

見出しを翻訳した場合に、アンカーリンク(ページ内リンク)用の見出しIDを設定していないと、その見出しへのリンクは日本語を含んだURLになってしまいます。
英語ページに記載されているURLをそのまま使えるようにするために、見出しIDを設定することを記載します。

  • 各セクションの見出しを翻訳した場合は、その後ろに{#見出しID}の形式でアンカーリンクを設定する
    • 例: ## リファレンス {#reference}
    • 見出しIDは、英語ページでの見出しのパーマリンクを確認して、URLの#以降を使用する

ブログ記事を翻訳する際の留意事項を記載する

ブログ記事特有の対応として、以下を記載します。
なお、翻訳者の掲載は強制するものではないと考えて、やり方を記載する表現に留めました。

  • ブログ記事については、次のことに留意する
    • メタデータのevergreen: trueは削除する
    • PR作成者とレビュアーは、以下の形式で翻訳者として名前を掲載できる(サンプル)
      translator: >
        [PR作成者の名前](GitHubのURL) ([所属](所属のURL)),
        [レビュアーの名前](GitHubのURL) ([所属](所属のURL))
      

カタカナ語についての基本方針を記載する

翻訳の際に、カタカナ表記にするか、和語や漢語にするかで迷うことがあります。
今回の更新では、具体例の列挙はしませんが、基本方針として次のことを記載します。
例は1つだけ入れます。

  • カタカナ語の多用を避けるため、和語や漢語でも自然に表せる場合はそちらを優先する
    • 例: ターゲット→対象
    • ただし、カタカナで定着している用語はその限りではない

Metadata

Metadata

Assignees

Labels

area/localizationGeneral issues or PRs related to localizationkind/featureCategorizes issue or PR as related to a new feature.language/jaIssues or PRs related to Japanese languagetriage/acceptedIndicates an issue or PR is ready to be actively worked on.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions