Rails開発での疑問が生産性を損なうのを防ぐ方法

『Practicing Rails』好評発売中!2月13日(金)まで25%オフで購入できます。

コードを書いていると、頭の中に絶えず疑問が浮かんできます。「このメソッドはどう呼べばいい?」「どんなオプションを受け付ける?」「引数に数値の代わりにオブジェクトを渡したらどうなる?」——そんな具合です。

こうした疑問は、あなたの生産性を着実に蝕んでいきます。すぐに答えがわからないと、何をしていたのか忘れてしまいます。フロー状態から強制的に引きずり出され、元の作業に戻るまで30分もかかることさえあるのです。

では、スピードを落とさずに必要な答えを見つけるには、どうすればよいのでしょうか?

高速なドキュメント検索

APIドキュメントを調べるとき、最も重要なのはスピードです。答えを得たら、一刻も早く作業に戻りたいものです。そうしないと、あっという間に脱線してしまいます。メソッドのパラメータを調べようとしたはずが、気づけばRedditで1時間も過ごしていた——そんな経験は誰にでもあるのではないでしょうか。

高速なドキュメント検索には、MacならDash、WindowsやLinuxなどその他のOSならZealがおすすめです。これらのツールを使えば、キーボードの2つのキーを押すだけで、思考を中断することなく必要なドキュメントを即座に表示できます。

ただし、その前にほんの少し初期設定が必要です。

アプリをダウンロードしたら、次の2つを行いましょう。

1. 使用しているライブラリのdocsetをダウンロードする。

   Ruby、Rails、CSS、HTML、JavaScriptあたりを入れておけば十分です。Nokogiriのように複雑なgemを頻繁に使うなら、そのドキュメントも追加しましょう。ただし、入れすぎには注意が必要です。ドキュメントが多すぎると、「どのconcatメソッドを探したいのか」を判別するだけで余計な時間を取られてしまいます。

2. グローバル検索ショートカット(Global Search Shortcut)を設定する。Macならoption+Spaceがおすすめです。

   この設定こそが、Dashを「単なるドキュメントサイト」から手放せない必須ツールへと変えるポイントです。ショートカットを設定すれば、option+Spaceを押して文字を打ち込み、必要なドキュメントを目で追い、もう一度option+Spaceを押す——これだけで答えが手に入ります。意識する前に、APIに関する疑問がすでに解決されている、という体験ができるのです。

より詳しい情報、質問、コメント

残念ながら、公式のAPIドキュメントに知りたい情報がすべて載っているとは限りません。機能の内部動作を把握する必要が生じることもあるでしょう。

こうした疑問への回答には、多少のスピードを犠牲にする覚悟が必要です。しかし、その代わりに詳細さとコミュニティの知恵を提供してくれるドキュメントサイトがあります。

APIDock

APIDockがカバーしているのはRuby、Rails、RSpecのみですが、それでも十分に役立つサイトです。

• Railsメソッドが非推奨(deprecated)になった時期と、代わりに使うべきメソッドを教えてくれる。Rails 1.0以降のバージョン間の変更履歴がすべて記録されているため、レガシーなRailsコードを扱うときには非常に貴重なリソースになります。

• 多くのAPIメソッドには、Rails開発者たちによるコメントが寄せられている。しかもそのコメントの質が非常に高いのです。APIDockを活用すれば、エッジケースやよくある落とし穴を、実際に遭遇する前に知ることができます。

新しいドキュメント検索ワークフロー

では、これらをどのように組み合わせればよいのでしょうか?

1. APIについて疑問が湧いたら、まずホットキーでDashまたはZealを素早く呼び出します。
2. さらに詳しい情報が必要な場合はWebへ。まずはAPIDockを試してみましょう。特に、古いRailsアプリのAPIを調べるときに威力を発揮します。

ドキュメントに瞬時にアクセスできるようになると、Rails開発の生産性は劇的に変わります。集中力が保てるだけでなく、日々依存しているライブラリやフレームワークへの理解も自然と深まっていくのです。

使うすべてのツールについて、すべてを知ることはできません。プログラマーは、ある程度ドキュメントに頼らざるを得ないものです。だからこそ、今この瞬間に少し時間を投資して検索環境を整えておけば、その後の調べ物のたびに時間を節約できます。その見返りは、プログラマーとしてのキャリア全体を通じて、計り知れないものになるはずです。