Railsの質問が生産性を損なうのを防ぐ方法

APIドキュメントを検索するときは、速度が重要です。 あなたはあなたの答えを得て、できるだけ早く出て行きたいです。そうでなければ、軌道から外れるのは簡単すぎます。メソッドのパラメーターを知る必要があった頻度を数えられず、どういうわけか、redditで1時間恥ずかしいテキストメッセージを見ることになりました。

迅速なドキュメントを作成するには、Macの場合はDash、その他の場合はZealが必要です。 これらのツールを使用すると、キーボードの2つのキーを押して、何をしているのかを考えることなく、必要なドキュメントを表示できます。

ただし、最初に少しセットアップする必要があります。

これらのアプリのいずれかをダウンロードしたら、次の2つのことを行います。

1. 使用するライブラリのドキュメントセットをダウンロードします。

   Ruby、Rails、CSS、HTML、Javascriptのドキュメントを入手しましたが、それだけです。のこぎりのように、よく使う複雑な宝石がある場合は、それらのドキュメントも入手してください。ただし、やりすぎないでください。ドキュメントが多すぎると、どのを見つけようとしても速度が低下します。 concat あなたが実際に意味する方法。

2. グローバル検索ショートカットを設定する 。 Macでは、通常、オプション-スペースを使用します。

   これが、Dashを「単なる別のドキュメントサイト」から完全に不可欠なツールに変えるものです。グローバル検索ショートカットを設定したら、オプション-スペースを押して入力を開始し、必要なドキュメントを表示して、オプション-スペースをもう一度押して、今何をしたかわからなくても答えを得ることができます。 APIの質問に、自分が持っていることに気付く前に答えることができます。

詳細、質問、コメント

残念ながら、APIドキュメントに知りたい詳細がすべて含まれていない場合があります。または、機能が内部でどのように機能するかを知る必要があるかもしれません。

これらの質問に答えるには、速度を犠牲にする必要があります。しかし、その速度を詳細とコミュニティに置き換えるドキュメントサイトがあります。

APIDock

APIDockは、Ruby、Rails、およびRSpecのみを対象としています。しかし、それでも役に立ちます：

• APIDockは、Railsメソッドが非推奨になった時期と、代わりに何を使用すべきかを通知します。 Railsのバージョン間の変更を1.0まで追跡します。したがって、レガシーRailsコードを使用している場合、それは素晴らしいリソースです。

• 多くのAPIメソッドには、Rails開発者によるコメントがあります。 コメントは本当に良いです。 APIDockを使用すると、エッジケースと一般的な問題について前に聞くことができます あなたはそれらに遭遇します。