GitHubを使って一次情報を読もうな

はじめに

エンジニアとして成長したいのであれば一次情報を読むことから逃げてはなりません。今ではQiitaやtaratailといった技術スレッドで日本語翻訳され分かり易くまとまった情報に誰でもアクセスする事が出来るようになりました。何なら質問や意見を交わすことも可能です。何か課題があっても既に同じ課題に直面した先人達の足跡を参考にすることで効率的に解決が出来ます。

しかしこれらはあくまでも二次情報であることを理解しておくべきです。一見合理的に見える課題解決方法ですが二次情報のみで物事を考えているといつか必ず痛い目に遭いますし、かえって自分の成長を阻害する可能性もあります。技術者として高みを目指しているのであれば早い内から一次情報を読む癖を付けたほうが良いです。ということで今回は一次情報の読み方についてまとめてみました。

公式ドキュメントを読む

Qiitaなどを読んでも理解出来ない、課題を解決出来ない時は繰り返し同じ様な二次情報を探すのではなく公式ドキュメントを見てみると上手くいくことがあります。公式ドキュメントとは公式サイトやGitHubのREADMEなどのことです。この辺は大抵が長文であったり英文であったりと難かしそうな印象があり読むのが憚られるのですが、作り手の読んで欲しい情報がそこにあるので出来る限り目を通した方が良いです。

とは言え全文を読む必要はありません。コードの部分や単語から辺りを付けて重要な部分だけを読んでみるだけでも十分に効果があります。自分自身三行以上あるだけでうんざりする程ドキュメントを読む行為が苦手なのですが、ご飯を食べながらなど気を紛らわしながら読むよう心掛けています。

GitHubのソースコードを読む

二次情報、公式ドキュメントを読んでもライブラリの挙動を理解出ない、あるいは手元で検証しても分からない場合に次に読むべきものはソースコードです。いざこれを行動に移すのは些か勇気がいります。それはソースコードなんて壮大で理解するのは難しいとか時間が掛かりそうという先入観があるからです。そもそも透過的に利用出来るからこそライブラリとは便利なのであってソースコードを理解しようという発想は出づらい節があります。それでもソースコードには答えが必ず乗っていますし、何なら開発者にissueを投げつけてやりましょう。(むしろ喜ばれます)

これはある程度言語仕様に慣れてからやってみるのが一番良いと思いますが、普段コードを書いている言語であれば意外と読めてしまうものです。食わず嫌いで読んでいないのであれば今後は読んでみることをおすすめします。

そしてご存じないかもしれませんが最近のGitHubはコードリーディングをするのに便利なUIが備わっているのです。例えば左上の検索窓ではリポジトリ全体に対して全文検索を行えます。

他にもメソッドをクリックすると定義元にジャンプする事が出来るので、狙いのメソッドの中身をすぐに確認することが可能です。

最近でもDeviseTokenAuthというトークン認証を提供してくれるRuby GEMの使い方が分からずソースコードを読んでみたのですが、DBには発行したトークンのハッシュ値を格納し、ブラウザには元のトークンの値を返してAPIは元のトークンを値を送信することで認証を行うという仕様になっておりました。これは二次情報にもドキュメントにも説明が無くソースコードを読むことでようやく理解が出来ました。

終わりに

先にも述べましたが私は未だに解説に英文があったり長文なだけでアレルギー反応の如くブラウザバックしてしまう癖が治らないのですが、二次情報だけでの学習方法には限界を感じてきました。これを機に公式ドキュメントやソースコードを覗いて見たいと思います。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA