translation_readme.md

Moddable 日本語翻訳プロジェクト

このリポジトリでは Moddable が提供するドキュメントを日本語に翻訳する作業を行っています。

ゴール

Moddable が提供するドキュメントを段階的に、いずれ網羅的に翻訳して、日本の開発者がModdableを使いやすくすることを目指します。

方針

• 翻訳は完全性よりも速度を重視し、まずはドキュメント全体を一通り翻訳することを目指します
• リポジトリに翻訳を取り込む際は、1名以上の日本語話者によるレビューを行い、翻訳の質を担保します
• 詳しい進め方は作業を行いながら話し合って決めます
  • 進め方について提案がある方は、お気軽に issue を立ててみてください

プロジェクトへの参加

• 本プロジェクトに参加するには、Githubのアカウントが必要です
• 「翻訳者」または「レビュアー」として参加できます
  • 翻訳者：後述の「翻訳作業の流れ」に則ってPull Requestを作成してください。初回のPull Requestを送る際は、Contributor License Agreement（CLA）へのサインが必要です
  • レビュアー：日本語能力とModdableの知識が十分にあると認められる方はレビュアーとして参加できます。ししかわまで連絡してください

翻訳作業の流れ

• issue で翻訳する文書を宣言します
• ドキュメントを翻訳します
  • 翻訳作業の中心である dev/translate-jp から作業ブランチを切ります
  • リポジトリに含まれる英語文書を翻訳し、同じファイル名で 上書きしてコミット することで日本語訳を作成します
• 文章校正を行います
  • textlint を用いて文法や用語の表記ゆれを自動チェックします
  • 次のコマンドでチェックを行います。指摘がある場合、修正します

cd textlint
npm install #初回のみ
npm run textlint

• Pull Requestを作成します
  • 1名以上のレビュアーがレビューして修正依頼または承認を行います
  • Pull Requestをマージします

公式リポジトリの更新に追従する

• 公式リポジトリに更新があった場合の翻訳作業も基本的には前述の流れで行います。
• 公式リポジトリの翻訳したいブランチを、moddable-jpの作業ブランチにマージします。
  • 公式リポジトリの変更差分がコンフリクトとして現れるので、差分を翻訳してマージコミットを作成します。

Discordサーバ

• 翻訳の進め方に関する相談、提案は issue で行います
• issueを立てるまでもないカジュアルなやりとりなど、プロジェクトメンバー間のコミュニケーションには、 Discordサーバーを使用しています
• Discordサーバーの招待リンクから参加してください

自動翻訳

ChatGPTなどのAIを使った自動翻訳を利用できます。 ChatGPT Markdown Translatorを使うとマークダウンの文書単位で自動翻訳にかけることができます。 ツールの設定例（.envとprompt.md）をchatgpt-md-translatorに置いていますので活用してください。

注意点

• ChatGPT Markdown Translatorを使う際、出力ファイルのオプション（-o）を与えない場合は、元ファイルを上書きする挙動になるので注意してください
• 出力される翻訳のクオリティは80点程度であり、誤訳や用語の表記ゆれを多く含みます。Pull Requestを作成する前に、必ず全文を自身でチェックしてください