Electronドキュメントの翻訳 (Crowdinへの移行) : Electron Advent Calendar 2017 day 4

2017-12-04 14:55 JST by kcrt

 

Electronの多言語ドキュメントが最近Crowdinへ移行し、翻訳作業が大変やりやすくなりました。

ここでは、その経緯と使い方について説明しています。

なぜCrowdinに移行したの?

もともとは日本語など、英語以外のドキュメントもelectronレポジトリの中に含まれており、翻訳を行う際にはdocs-translationsを編集してpull requestを送る、という方法で行われていました。

しかし、この方法には

  1. ドキュメントがなかなか英語の最新版に追いつかない
  2. Pull requestの処理が大変

という問題がありました。

一点目の「ドキュメントがなかなか英語の最新版に追いつかない」ですが、docs(英語版)のドキュメントが編集され、新しいメソッドの追加やメソッド名の変更があったり、書かれていた方法がDeprecatedになっていても、なかなか翻訳版のほうがそれに追いつかなかったり、またたくさんの言語があるために言語ごとにバラバラの作業で一貫性が保てていないという状態になっていました。

二点目の「Pull requestの処理が大変」ですが、electronリポジトリには、たくさんのPull requestが送られていますが、動作に関わるもの多くなかなか大変そうです。それにもかかわらず、細々したドキュメントの翻訳などのmerge作業もCheng ZhaoさんZekeさんをはじめとしたElectronの開発コアメンバーが行うことになってしまっていました。

そこで、翻訳の作業の効率化と質の向上のためCrowdinに移行することになりました。

doc-translationsディレクトリは、Deprecate /docs-translations #11039をもって削除されて空になっています。

Crowdinってなに?

CrowdinはWebから使用できる翻訳プラットフォームです。Githubとの連携がとてもしやすく、またオープンソースソフトウェアの開発には無料で使用できるという大きなメリットがあります。

一度翻訳した言葉をドキュメント内で一貫性を保つためにシソーラスを作ったり、機械翻訳を参考にしたり、複数人での作業のために投票機能があったりと、さまざまな機能があります。

どうやって使うの?

まずはCrowdinのユーザー登録を行います。登録にはGithubやTwitterのアカウントを利用することが出来ます。登録後、Electronドキュメント翻訳のプロジェクトを開きます。

言語の設定を行っているためJapaneseが一番上にあがっています。翻訳を行う言語をクリックします。

クリック後は、ドキュメントに含まれるファイルが出てきます。右の青いバーが翻訳率で、こう見ると日本語はほとんど翻訳されていないファイルも多いのが分かります。

今回は、翻訳が全くされていないinstallation.mdを翻訳することにしてみます。ファイルを開くと下のような画面が表示されます。

左側に翻訳文書全体が表示されます。赤がまだ作業を行っておらず未翻訳の部分、黄色が現在編集中の部分、緑が翻訳済みの部分です。

右側で実際の翻訳作業を行います。場合によっては下の機械翻訳や、過去に翻訳したドキュメントに同じ文章があれば表示されますので、それを参考にします。タグは<0></0>といった形で原文の物を引用できます。

翻訳の都合上、タグの順番が変わったり、括弧の対応が減ったりすると警告が表示されますが、わかりやすい翻訳にするためにあえて文書を構成した場合は気にしなくてかまいません。

翻訳されたドキュメントはどこから見るの?

翻訳されたドキュメントは、Crowdinからしばらくするとelectron-i18nリポジトリに取り込まれ、Electronのウェブサイトから見ることが出来ます。数日以上かかることもあるので気長に待ちましょう。