Vue.js(Vue 3) のドキュメント翻訳に参加してみた話
この記事は マイナビ Advent Calendar 2020 の21日目の記事です.
昨日は @object97 さんの SalesforceのREST APIのCRUDをphpで実現する でした. Salesforce って使ったこと無いんですが,API 用意されてるんですね! 外部のWebアプリのリアルタイム連携ってどんな事例があるのかちょっと気になりました!
今回は以前 Vue.js(Vue 3) のドキュメント翻訳に参加し,学んだことや感じたことをまとめてみようと思います.
ドキュメント翻訳って自分にはできなさそうって思っている人の少しでも参考になれば嬉しいです.
きっかけ
Vue.js の情報をキャッチアップしやすくするために以前から「Vue.js 日本ユーザーグループ」の Slack ワークスペースしていたのですが,その翻訳チャンネルで Vue 3 のドキュメント翻訳をする方を募集していたのがきっかけでした.
「Vue.js 日本ユーザーグループ」の Slack ワークスペースはこちらのリポジトリに詳細があります.
以前知り合いのエンジニアが翻訳に参加していた話も聞いていてその時はどうやって参加したのかが検討もつかなかったのですが,こういった活動をしたい場合はやはりコミュニティに入ると把握しやすいことがよくわかりました.
なぜ参加したか?
前々から「英語に関わる時間を増やそう増やそう」とただ言っているだけで文法書を読むなどのインプットはできてもアウトプットが中々できていないことに課題感がありました.
「英語でのアウトプット」って他に何かないだろうかと何となく考えていたときに今回の募集を聞いたときに,英語でのアウトプットもできるし Vue.js のコミュニティにも貢献できて一石二鳥だと感じ参加してみたいと感じ思い切って参加をしてみました.
関わったドキュメント
私が関わったドキュメントは ルーティングです. Slack の翻訳チャンネルで参加する旨をコメントしたところ翻訳プロジェクトの主催者の方から issue で assign され,Description を内容を基に翻訳のプルリクエストを作成しました.
翻訳の量としては少ない方でしたが,それでもどういう日本語の表現にすればしっくりするのかは結構考えてしまいました.
プルリクエストを作ったときは結構緊張したのですが,サクッとマージすることができて良かったです🎉.
もし翻訳の修正箇所があればプルリクエスト上でフィードバッグを貰えるようです.
参加して学んだこと・良かったこと
英語でのアウトプットができた
ここは狙い通り英語でアウトプットをする1つの方法であると実感することができました. ドキュメントの量は少ない方でしたが,今回の経験を通して翻訳作業の経験をまずは1回経験することができたので今後もチャンスがあれば参加していこうと思います.
他リポジトリの issue・プルリクのルールや CI/CD に触れられるのが新鮮
これは自分でも予想外でしたが,普段自分が開発で関わっているリポジトリでは issueやプルリクのルールはそこまで頻繁に変わることがありませんでした.
そのため今回のような形で他のリポジトリに参加すると issue やプルリクエストのルールが全然違うため「なぜそういうルールにしているのか」,「自分が普段関わっているリポジトリではなぜこういうルールにしているのか」など自分が普段関わっているリポジトリのルールを見直すきっかけや他のリポジトリで良い Tips があれば吸収できるきっかけになることがよくわかりました.
また,今回私が参加したリポジトリでは GitHub Actions を CI に,Netlify を CD に利用しており,普段開発で使っていないものでかつめっちゃ便利であることがよくわかったので,今回の翻訳を通してこれらの CI/CD をキャッチアップしたいと思うきっかけにもなりました.
コミュニティに貢献できた
普段自分や世界中の人がお世話になっているコミュニティに少しでも貢献できたのが純粋に嬉しくてやり終えた後の達成感がありました.
まとめと所感
今回は Vue.js(Vue 3) のドキュメント翻訳に参加してみた話についてまとめてみました.
翻訳作業と聞くと英語や日本語だけの話に感じてしまうとイメージがありますが,OSS の参加のし方やリポジトリでの issue やプルリクエストのルール,翻訳作業をするにあたって必要な技術について触れることができるので想像以上に学べることがたくさんあります.
今後も翻訳チャンスがあればチャレンジしていこうと思うのと,コードでの貢献のチャンスも探していこうと思います.