Angular 向け Storybook のチュートリアルを日本語訳しました
「Storybook 使いたいんじゃ〜」の布教に無事成功して、社内のプロジェクトで本格的に Storybook を使うことになりました。同僚への資料作成(とはいえ業務時間中に作業したわけではないですが)を兼ねて、Angular 向け Storybook のチュートリアルの翻訳プロジェクトに参加しました。
無事公開されたので、今後の自分の学びのために勉強になったことや感じたことなどを羅列してみました。
ドキュメントを翻訳してくれる方に感謝
一番勉強になったのは、普段利用しているツールの日本語ドキュメントのメンテナンスにどれだけの労力が注ぎ込まれているかと言うことです。本家の英語版の更新に追いついていなかったり、訳が読みにくいドキュメントにいらだったことが何度もあります。しかし自分が実際に翻訳をする立場になり、読んで理解するのと自然な日本語に訳すことは大きく違うことや、随時更新される断面に追いついていくことの大変さが分かりました。もう 2 度と技術文書の翻訳に文句を言いません。多分。
レビュワーに感謝
翻訳のプルリクエストは、ネイティブスピーカーのレビューを受けることになっています。私も一旦翻訳を終わらせたあと、React 版の翻訳をされていた方にレビューしていただきました。この方が想像以上に丁寧にレビューをしてくださいました(今GitHubをもう一度見たら 72 件もレビュー指摘をしてくれてました)。凡ミス系が多く、本当に申し訳なかったです(一応終わってから見直してたんですが...)
「木を見て森を見ず」はだめ
レビューでもらった指摘はしてもらったことを振り返ると、そのコードや説明の一行だけを見るとこういう風にも訳せるかもしれないけれども、チュートリアル全体の流れや Angular のプラクティスとしてどうかという観点が抜けていました。指摘事項についてReact の英語版でこうなんだけどなぁと思いつつ確認してみたら、やっぱりレビュワーさんが正しくて React の英語版が間違っていた、と言うのもあったりしました。こういう齟齬に気づくかどうかは、抽象的な言い方になりますが大局観があるかないかなんだと思います。
翻訳は短期集中でやった方がいい
土日の時間のある時にのんびり作業していたのですが、その間に本家の英語版が更新されてしまいました(2 回も。どんだけのんびりしていたのか。。。)どこまで訳してて、どこが本家の英語版で変わったんだろうを 1 つ 1 つ見ることになり大変でした。更新が入る前に英語の方でリンク切れになっている箇所があったのですが、翻訳が終わってからプルリクエストを投げようと思い日本語版もそのままにしていたら英語の方で修正が入ったりしました。上の方でも書きましたが、そんなこんなでチグハグになったところをレビュワーさんが 1 つ 1 つ指摘してくださることになり、迷惑をかけてしまいました。
エディタやツールを上手に使うの大事
当たり前のことなのですが、上記のような変更を追いかけながら改めてツールを使いこなすことの重要性を感じました。例えば VS Code + Neo Vim 拡張 で作業していたのですが、GitLens などの拡張機能を使って英語版の差分を見るとか、英語版に入ったソースコードの修正をコピーして日本語版に反映するのを繰り返すのに Vim のマクロを使ったりとか。作業の後半は前半よりも効率的に作業できましたし、ここで Vim のバインディング使えるなって感覚は業務にも活きています。
以上です。レビュワーの方もファシリテーターの方も Welcoming な方でした。OSS への貢献がマージされたのは初めてなのですが、最初の OSS が Storybook でよかったです。せっかく翻訳したので、たくさんの人に使ってもらえると嬉しいです。
Discussion