Skip to content

翻訳ルール ​

日本語を原文とし、初期範囲はREADMEと「はじめに」「30分セットアップ」「最初のコントリビューション」の英語版とします。訳文はページ全体を揃えてから掲載し、意味と読みやすさをレビューします。

AIへの手順 ​

翻訳先 ​

  • サイト: docs/guide/setup.md → docs/en/guide/setup.md
  • README: README.md → README.en.md。両方に相互リンクを設ける
  • 英語トップ docs/en/index.md は、翻訳範囲と入口を案内する独立したページとして扱う

変更するもの・維持するもの ​

本文、見出し、表の文章、コードのコメント行、囲み枠のタイトルを英訳します。frontmatterは表示文言を翻訳し、キーと theme の値を維持します。

コマンド、ファイル名、環境変数名、数値、出力例は維持します。ただし、入力時に置き換える次の記入例は対応する英語表記にします。検査もこの対応だけを許可します。

原文の記入例英語表記
<あなたのアカウント><your-account>
0xあなたのアドレス0xYourAddress
<ブランチ名><branch-name>

::: の直後の種別語、Initiation・Allowlist・Check-in・HENKAKUなどの機能名、/setup などのアプリのパスは維持します。

サイト内リンクは翻訳済みページなら /en/ へ向け、未翻訳なら日本語ページへのリンクに (Japanese) を添えます。frontmatterのリンクも同様です。READMEではファイルへの相対リンクと公開サイトのURLを使い分けます。

翻訳で仕様やコマンドを変更しません。日本語原文の改善や、原文にない補足が必要な場合は、訳文へ追加せず報告します。言語切り替えと原文・同期情報の表示は翻訳管理のための付記として扱います。

原文と翻訳元の記録 ​

各英訳の冒頭に、日本語原文へのリンクと、翻訳元のコミットに固定した原文へのリンクを記載します。リンクの表示は短いコミットID、URLには完全なコミットIDを使います。READMEも同じ形式とし、独立して書く英語トップは対象外です。

日本語原文が更新されたら、記録した版と現在の原文を比較し、必要な箇所を英訳に反映してから翻訳元の記録を更新します。コミットIDだけを先に進めません。原文への追従は手動で確認し、英語表現のレビュー結果はPRに記録します。構造検査は原文との同期やレビュー完了を保証しません。

検証とレビュー ​

翻訳のみの変更では、対象ファイルごとに構造検査し、サイトをビルドします。

bash
npm run docs:check -- docs/en/guide/setup.md
npm run docs:check -- README.en.md
npm run docs:build

docs:check は見出しの数と階層、コードブロック、囲み枠の開始と種別、表の行数を比較します。コードはコメント・空行と上記の記入例を除いて比較します。通常のMarkdown形式のサイト内リンクを検査し、日本語の残存と一部の見出しリンクを警告します。

見出しリンクは簡易判定で、警告だけではCIは失敗しません。frontmatter内の文言やリンク、READMEの相対リンク、文章の意味や抜け、画面上の表示はレビューで確認します。docs:build はサイトのページへのリンクを確認しますが、見出しへのリンクは保証しません。

エラーは修正し、警告は対象箇所を確認して対応と理由を報告します。検査ツールや設定コードを変更する場合は、翻訳のみの場合とは別に、対象のテストを実行します。

報告とPull Request ​

依頼者には日本語で、翻訳したファイル、検査・ビルド結果、警告への対応、訳に迷った語や原文の不明点を報告します。PRには「変更理由 / 検証内容 / 未解決の判断」と翻訳に使ったAI名を記載します。

作業範囲の共有とPRの手順は最初のコントリビューションを参照してください。

秘密情報(SESSION_PASSWORD、Supabaseキー、Safeの認証情報)はドキュメント・Issue・ログへ貼らないでください。