Skip to content

Commit 1d75ebc

Browse files
authored
docs: 翻訳作業についてのドキュメントとPRテンプレートを修正 (angular#1016)
- 改行数の一致についてのチェックを強調 - AI翻訳のガイドの記述が古い部分を更新
1 parent 1e50d98 commit 1d75ebc

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed

.github/pull_request_template.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
## 翻訳・修正
22

3-
- [ ] 変更内容は[CONTRIBUTING.md](https://github.com/angular/angular-ja/blob/main/CONTRIBUTING.md) に記載されたワークフローに従っています
3+
変更内容は[CONTRIBUTING.md](https://github.com/angular/angular-ja/blob/main/CONTRIBUTING.md) に記載されたワークフローに従っていることを確認してください。
4+
5+
- [ ] [翻訳のガイドライン](CONTRIBUTING.md#%E7%BF%BB%E8%A8%B3%E3%81%AE%E3%82%AC%E3%82%A4%E3%83%89%E3%83%A9%E3%82%A4%E3%83%B3)を確認しました。
6+
- [ ] 原文ファイルと翻訳ファイルの改行数が一致しています。
47

58
## 関連Issue
69

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@ https://github.com/angular/angular/tree/main/adev
2626

2727
## 翻訳の追加
2828

29+
> [!NOTE]
30+
> まとまった量のテキストの翻訳を省力化するため、Googleの[Gemini API](https://ai.google.dev/gemini-api?hl=ja)を使ったAI翻訳を導入しています。詳細は[TRANSLATION_WITH_AI.md](./docs/TRANSLATION_WITH_AI.md)を参照してください。
31+
2932
未翻訳のドキュメントをあらたに翻訳するには、翻訳時点での原文を `xxx.en.md` ファイルとして保存し、`xxx.md` を翻訳します。以下のステップで翻訳を進めてください。
3033

3134
- `xxx.md` ファイルをコピーして `xxx.en.md` ファイルを作成する
3235
- `xxx.md` ファイルを翻訳する
3336

34-
まとまった量のテキストの翻訳を省力化するため、Googleの[Gemini API](https://ai.google.dev/gemini-api?hl=ja)を使ったAI翻訳を導入しています。詳細は[TRANSLATION_WITH_AI.md](./docs/TRANSLATION_WITH_AI.md)を参照してください。
35-
3637

3738
## ローカル環境のセットアップ
3839

docs/TRANSLATION_WITH_AI.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@
44

55
## 使い方
66

7-
翻訳翻訳スクリプトは `tools/translate.ts` に書かれています。以下の手順で翻訳を行います
7+
AI翻訳スクリプトの実装は `tools/translator` に配置されています。AI翻訳は以下の手順で実行します
88

99
```
1010
$ yarn translate <翻訳元ファイル・ディレクトリ> [--write]
1111
```
1212

13-
ディレクトリが指定された場合、そのディレクトリのファイルがリストアップされ、どのファイルを翻訳するかを選択できます。
14-
1513
`--write` オプションを指定すると、確認なしに翻訳結果をファイルに書き出します。指定しない場合は、翻訳結果が標準出力に表示されたうえで、保存するかどうかを確認します。
1614

1715
例えば、以下のように実行します。
@@ -30,13 +28,18 @@ Gemini APIを利用するためには、APIキーが必要です。APIキーは[
3028
- 「APIキーを作成」をクリックします。
3129
- 任意のGoogle Cloudプロジェクトと紐づけて、APIキーを作成します。
3230

33-
APIキーはを環境変数 `GOOGLE_API_KEY` に設定した上で、`tools/translate.ts` を実行すると、APIキーが利用されます。
31+
APIキーはを環境変数 `GOOGLE_API_KEY` に設定した上で、`tools/translate.ts` を実行すると、APIキーが利用されます。レポジトリルートに `.env` ファイルを作成し、以下のように設定してください。`.env` ファイルは `.gitignore` に含まれているため、APIキーがリポジトリに含まれることはありません。
32+
33+
```
34+
GOOGLE_API_KEY=<APIキー>
35+
```
36+
3437

35-
> [!TIP]
36-
> `translate.ts` で利用しているモデルは "[Gemini 1.5 Flash][]" です。このモデルは無料で利用できる使用量上限がありますが、ふつうに翻訳しているだけであれば無料枠で十分です。しかし、原理的には従量課金されうることを了承のうえで利用してください。また、発行したAPIキーが漏れないように注意してください。
38+
> [!WARNING]
39+
> `translate.ts` で利用しているモデルは "[Gemini 2.0 Flash][]" です。このモデルは無料で利用できる使用量上限がありますが、ふつうに翻訳しているだけであれば無料枠で十分です。しかし、原理的には従量課金されうることを了承のうえで利用してください。また、発行したAPIキーが漏れないように注意してください。
3740
3841

39-
[Gemini 1.5 Flash]: https://ai.google.dev/gemini-api/docs/models/gemini?hl=ja
42+
[Gemini 2.0 Flash]: https://ai.google.dev/gemini-api/docs/models/gemini?hl=ja
4043

4144
## 注意
4245

@@ -46,8 +49,8 @@ APIキーはを環境変数 `GOOGLE_API_KEY` に設定した上で、`tools/tran
4649

4750
### 大きなファイルの翻訳
4851

49-
Gemini APIの出力トークン上限の都合上、大きなファイルを一度に翻訳することができません。入力されたファイルの文字数が一定数を超える場合、対話的にいくつかの断片ごとに結果を出力したあとに結合しています。分割もAIに行わせているため、接合部分に不自然な切れ目が生じることがあります。手で修正してください
52+
Gemini APIの出力トークン上限の都合上、大きなファイルを一度に翻訳することができません。そのため、いくつかの断片ごとに結果を出力したあとに結合しています。接合部分に不自然な切れ目が生じることがありますので、その場合は修正してください
5053

5154
### プロンプトの改善
5255

53-
もし、翻訳結果を確認するためのプロンプトを改善したい場合は、`tools/translate.ts` を修正するプルリクエストを送ってください。
56+
もし、翻訳結果を確認するためのプロンプトを改善したい場合は、`tools/translator` を修正するプルリクエストを送ってください。

0 commit comments

Comments
 (0)