彼女からは、おいちゃんと呼ばれています

ウェブ技術や日々考えたことなどを綴っていきます

Nuxt.js 公式ドキュメントの翻訳スタイルをアップデートした

Nuxt.js 公式ドキュメントの翻訳スタイルの紹介 のつづき。エントリーを公開したときに次のようなコメントをいただいた。

Nuxt.js 公式ドキュメントの翻訳スタイルの紹介 - 彼女からは、おいちゃんと呼ばれています

更新の際に、原文を更新するの面倒くさい問題は、どう解消しているのでしょう?

2017/03/27 13:58

なるほど、もっともだなーと思いつつも、それに対する解は今後やりながら考えようと思っていた。

で、少し経験値が溜まって、自分なりの答えが見い出せたので紹介する。

結論: 翻訳スタイルをアップデートする

  • 原文のコメントアウトを消す
  • 原文の更新が日本語訳に反映されているか否かを確認できるようにするために、原文を更新するプルリクエスト(または master ブランチへの直接コミット)に対して、日本語訳に反映させるプルリクエストからリンクを貼る
  • メジャーアップデートに伴うドキュメント刷新作業のときには、原文のコメントアウトを復活させるつもりでいる

以下、この結論に至るまでの過程。

原文のコメントアウトは更新時にも役に立った

自分でも意外だったのは、原文のコメントアウトは更新時にも役に立つ、ということ。

  • (1) 原文が更新されたときに、日本語訳の該当箇所を見つけやすい
  • (2) 日本語訳が最新版なのか否かが把握しやすい

(1) はまあ大差ないかもしれない。しかし (2) の点は、原文と日本語訳内の原文のコメントとを見較べると一目瞭然なのでメリットは大きかった(特に原文の更新を日本語訳に反映させる作業をしばらく放置した後にカムバックしたときなどは)。

現状は日本語訳のメンテナンスをしている人は僕 + α という感じなので、どこまで最新が反映されていて、どこが反映されていないのか把握できているけれど、人数が多くなってくると、何かひと工夫必要だろうなと考えている。

原文のタイポや文法的な誤りの修正を反映させる手間

一方で面倒だなと感じたのは、原文のタイポや文法的な誤りの修正を反映させる作業。本来、日本語訳には影響ないのに、日本語訳のファイルに原文をコメントで残しているがゆえに反映させる必要が生じる。

特に Nuxt.js は作者である Chopin ブラザーズ(本当に兄弟)が英語が母国語ではないので、英語的にはもう少しこう書いたほうが良いみたいなプルリクエストがたまに作られる。

そして下記のプルリクエストを目にしたときに、あー、これを反映させるのは…ちょっと…大変だな…と思い、再考を余儀なくされた。

再考

まず、上のプルリクエストのような原文をより良くするプルリクは歓迎されるべきものである。

にもかかわらず、現状の、原文をコメントアウトで残す翻訳スタイルでは、どうしても面倒だなと思う気持ちが出てしまって、心から歓迎できない。

それは望んでいる状態ではないから改善すべき。よし消そう。消した。

原文の更新が訳に反映されているかを確認できるようにする

一方で、先に書いたように、何らかの仕組みで、原文の更新が日本語訳に反映されているか否かを確認できるようにする必要があるので、現時点では原文を更新するプルリクエストに対して、日本語訳に反映させるプルリクエストからリンクを貼って「このプルリクエストの差分は反映させているよ」ということを示すようにしている。

Chopin ブラザーズ以外は原文の更新をプルリクエストでやってくれるからリンクを貼りやすいのだが、Chopin ブラザーズは master ブランチに直接コミットしているので、ちょっとそれ、追従しにくいんですケド…という気持ちもある(いつか伝えるつもりではいる)

いまのところ、当該 master ブランチへのコミットに対してリンクを貼る形で対応している。

メジャーアップデートについて

ではもう原文のコメントアウトをずっと使わないのかというと、そうではなくて、あれはあれで訳すときや訳を見直してブラッシュアップする際にすごく役に立ったので、次のメジャーアップデートのタイミングでまた使おうかと考えている。

メジャーアップデートつまり古いバージョンのドキュメントを残しつつ、新しいバージョンのドキュメントを一からドーンと用意する際に、原文を一旦日本語訳フォルダにまるっとコピーして、原文をコメントアウトで残しつつ翻訳するというイメージ。

今後のこと

Nuxt.js 自体もだが、そのドキュメントも更新の勢いがすごくて、ちょっと目を離した隙に日本語訳が原文から遅れを取ってしまった。やっていく。

2017年4月26日追記)日本語訳を原文に追いつかせる作業終わったー!