個人的なメモ

Tomohiro Suzuki @hiro128_777 のブログです。Xamarin に関する事を中心に書いています。 Microsoft MVP for Development Technologies 2017- 本ブログと所属組織の公式見解は関係ございません。

とっても簡単なので、Microsoft Docs にプルリクエスト を送ってみませんか。

はじめに


みなさま、Microsoft Docs はご活用されていますでしょうか。


aka.ms


Microsoft Docs はマイクロソフトが提供している各技術カテゴリごとのドキュメントです。それぞれのカテゴリについて充実した詳しいドキュメントが提供されています。

Xamarin につきましても Xamarin.Forms, Xamarin.iOS, Xamarin.Android, Xamarin.Mac, クロスプラットフォームと、5カテゴリについてそれぞれ詳しいドキュメントが提供されています。

その内容ですが、各カテゴリごとに環境のセットアップから、最初のアプリを作成するまでといったチュートリアル的なものから、それぞれのライブラリの API 設計の概念といった高度な内容までしっかりドキュメントが存在します。

よって、ドキュメントを熟読すれば、未経験でも Xamarin を始められるようなドキュメントになっています。


ですが、このドキュメントにはひとつ残念な問題があります。それは、基本的に「機械翻訳である」という事です。もちろん機械翻訳いってもひと昔のものとは違い、AIなどの活用でかなり精度は上がっており、不自然ながらも意味は読み取れるような文章にはなっていますが、読みにくいのは事実です。

もちろん、読みやすい日本語で読めるならそれに越したことはありません。そうであれば、自分の手で読みやすい日本語に修正してしまえばいいと言うのが本日のお話です。



いやいや、私は英語に自信がないので日本語へのローカライズにコントリビュートするとか無理なんですけど・・・


そんなことありません、英語が苦手でも大丈夫です。日本語の知識だけでも何とかなる部分もたくさんあります。

例えば 「章 1 です」-> 「第1章」などの修正であれば、英語力など関係なく修正可能です。このような不自然な表現が少しでも減るだけで、ドキュメントはグッと読みやすくなります。

今後、自分が読むときのストレスを軽減する意味でもプルリクエストを送る意味があると思っています。



間違った翻訳を送ってしまうのが怖いので、ちょっと無理かな・・・


そのような心配も無用です。プルリクエストを受け付ける側の担当の方がきちんと修正した日本語をチェックしてくれて、「適切」と思われる部分且つ、マイクロソフトの表現規約に沿ったものだけを取り込んでくれます。

ですので、間違った翻訳が取り込まれてしまう可能性は稀です。もちろん、可能な限り正しい内容のプルリクエストを送る必要がありますが、間違いを過度に恐れる必要はありません。

気軽な気持ちでまずは一度プルリクエストを送って見てはいかがでしょうか。



Microsoft Docs にプルリクエスト を送るのはとても簡単です。

Xamarin のドキュメントの場合の例


  1. https://github.com/MicrosoftDocs/xamarin-docs.ja-jp を自分のリポジトリに Fork します。

  2. 修正用のトピックブランチを切ります。

  3. 修正用のトピックブランチで修正し、自分のリポジトリにコミットします

  4. Github のForkした自分のリポジトリWebブラウザでアクセスすると、プルリクエストをオープンできるようになっているので、そのままプルリクエストをオープンします。

    コミットメッセージ、コメントともに、「fixed inappropriate Japanese」とでも書いておけば十分通じます。(正直この英語表現が正しいかはよくわかっていませんが・・・)

  5. 数日でプルリクエストがレビューされてマージされ、さらにその数日後に共同作成者のアイコンにあなたのアイコンが追加されます!



おわりに


修正のプルリクエストは、心構えをしてわざわざ時間をとって取り組むと言うよりは、ちょっとした時間にササッと見て気になる1センテンスだけをプルリクエスト送る方が気楽に取り組めると思います。

基本は自分が読んで意味が分からなかった表現に対してプルリクエストを遅ればみんな幸せになれるのではないでしょうか!

というわけで、皆さんも是非 Microsoft Docs にプルリクエスト を送って、日本語ドキュメントの改善にチャレンジしてみてはいかがでしょうか。