Japanese
Try Localizeflow

Use cases

OSSプロジェクト

Localizeflowを使用してオープンソースのドキュメントを翻訳する方法を学びましょう。

オープンソースプロジェクトは多くの場合、単一のREADMEから始まります。

コミュニティが成長するにつれて、異なる国のコントリビューターから翻訳の依頼が来るようになります。
README.ko.mdREADME.fr.md、その他の言語ファイルを手動で管理するのはすぐに困難になります。

Localizeflowは既存のワークフローを変更することなく、プルリクエストを通じてREADMEやドキュメントを自動的に同期します。

前提条件

  • GitHubアカウント。
  • 翻訳したいGitHub組織またはリポジトリへのアクセス権。

GitHub組織にLocalizeflow GitHub Appをインストールするには、組織のオーナーである必要があります
オーナーでない場合は、このページをオーナーに共有し、インストール作業を行ってもらってください。

リポジトリの準備(任意)

すでに手動で翻訳(例:README.ko.mddocs/ja/)を管理している場合は、
自動化を有効にする前に削除して、デフォルト言語を単一の信頼できるソースに保ってください。


Localizeflow GitHub Appへのサインインとインストール

  1. localizeflow.com にアクセスします。

  2. GitHubでサインインします。
    Sign in with GitHub

  3. Install in new account を選択します。

  4. Localizeflow GitHub Appをインストールしたいアカウント(個人アカウントまたは管理する組織)を選択します。


    GitHub組織にアプリをインストールするには、組織オーナーの権限が必要です
    オーナーでない場合は、このページをオーナーに共有し、インストール作業を行ってもらってください。

  5. Localizeflowにアクセスさせたいリポジトリを選択し、Save を選択します。
    Select repo and save

  6. Localizeflowダッシュボードにリダイレクトされます。


組織オーナーがLocalizeflow GitHub Appをインストールした場合、サイドバーのTeamページからチームメンバーをメール招待か招待リンク共有で招待できます。

Team


後からリポジトリを追加するには、ヘッダーのアカウントを選択し、+ Add more repositories を選びます。
Add more repositories

リポジトリをLocalizeflowに接続する

  1. Localizeflowホームページで、+ Connect repositories を選択します。
    Select connect repositories

  2. 1つ以上のリポジトリを選択し、Save を選択します。

  3. 接続されたリポジトリはHomeページとRepositoriesページの両方に表示されます。


最初の翻訳を実行する

リポジトリを接続した後、ダッシュボードから選択してオンボーディングウィザードを開きます。

ウィザードは2分以内で完了し、以下を定義します:

  • 対象言語
  • 翻訳で変更してはならない用語

ステップ 1: 言語と対象ブランチ

対象言語

1つまたは複数の対象言語を選択してください。
Localizeflowは選択したそれぞれの言語用にプルリクエストを自動生成・管理します。

言語は後ほどリポジトリ設定から変更可能です。

対象ブランチ

翻訳プルリクエストを開くブランチを指定してください。

  • 多くの場合、デフォルトブランチ(例:main)を使用します。
  • ステージングやドキュメント用ブランチを使っている場合はそちらを選択してください。

空欄の場合、Localizeflowはリポジトリのデフォルトブランチを使用します。

Step 1 – Select languages and target branch

Continue を選択します。


ステップ 2: 出力場所

プロジェクトタイプの選択

ほとんどのオープンソースリポジトリは以下の形態です:

  • ルートに README.md がある
  • シンプルな docs/ フォルダーがある
  • ドキュメントフレームワークを使わず、マークダウンベースのコンテンツを持つ

以下を選択します:

  • Simple repository

Step 2 – Select project type


ソースとターゲットのパスを手動で定義したい上級者は、Structured documentation siteを選んで翻訳グループを直接設定できます。

翻訳オプション

以下の追加処理を有効にできます:

  • マークダウン(デフォルト)
  • 画像翻訳(ベータ)(ドキュメントサイトでは利用不可)
  • ノートブック翻訳
  • 翻訳に免責事項を追加

多くのオープンソースプロジェクトでは、以下を推奨します:

  • マークダウンのみ(README中心のリポジトリ向け)
  • マークダウン+ノートブック翻訳(プロジェクトにJupyterノートブックや例が含まれる場合)

これでコミュニティ向けドキュメントはメンテナンス負荷を増やさずに利用可能に保てます。

Continue を選択します。


ステップ 3: 用語集と最終チェックリスト

自動化開始前に、翻訳時に変更してはいけない用語を定義できます。

用語集の作成(推奨)

用語集は以下を保護します:

  • 製品名
  • 会社名
  • 機能名
  • 法務またはコンプライアンスに関わるフレーズ

1行に1つの用語を追加してください。
追加した用語は翻訳文において変更されません。

例:

Localizeflow
Co-op Translator
GitHub App

用語集はあとで編集・追加も可能です。


最終チェックリスト

Save & Finish を選択する前に以下を確認してください:

  • ソースのパスがマークダウンファイルの場所と正しく一致している。
  • 既存の手動翻訳が生成されるアウトプットと競合しない。
  • 必要に応じて古くなった翻訳フォルダーを削除済み。

このチェックリストはファイルの重複やリンク切れ防止に役立ちます。


自動化を開始する

Save & Finish を選択するとリポジトリ詳細ページにリダイレクトされます。

翻訳は自動的には開始されません。

自動翻訳を開始するには:

  1. Automate を選択。
  2. Localizeflowがリポジトリをスキャン。
  3. 翻訳ジョブが生成される。
  4. 自動で下書きプルリクエストが作成される。

自動化はデフォルトで無効です。

有効にすると、ソースのREADMEやドキュメントが変更されるたびに、Localizeflowは翻訳プルリクエストを自動的に開いて更新します。

コントリビューターは他のプルリクエスト同様に翻訳変更をレビューできます。

Pause automate でいつでも自動化を一時停止可能です。