ひとまず前例を参照しよう (調べ物の仕方)
概要
何事も正しいやり方を調べずに当てずっぽうに取り組むべきではありません.質の良い使い方を知らずにプログラミング言語やライブラリを使うと碌なことになりません.
正しい使い方を調べる際に参照するのは,まず第一に公式の一次ドキュメントでしょう.これより確実な情報源はありません.しかし,公式ドキュメントには機能の紹介のための単純なコードが載っていることが多いです.
より実践的なコードの書き方を知りたい,あるいはそもそも解決方法のわからない課題を解決したい場合には,すでにそれを実現している前例を参照するのが有効です.
前例はそれを作った人たちがその人たちなりに経験や知識を総動員した結果です.それらは少なくとも何も参照せず自分一人で考えるよりは参考になるはずです.
これはいかなる場面においても汎用的に適用でき,かつついつい失念しがちであると思います.本稿では前例を探す際のコツも含めて紹介したいと思います.
前例の探し方
前例の探し方には,大きく探す媒体と言語という軸があると思います.
それぞれ具体的には次のようなものがあります:
媒体
社内か社外か | 媒体 | 説明 |
---|---|---|
社内 | Slack | 過去ログを検索できるため,「過去のどこかでそんな話をしたな」,「他の人が対応してくれたはずだけどその時の記録はどこだろう」,「質問したいけど過去に同じことを聞いている人がいないかな」みたいな時に便利. |
社内 or 社外 | Github | コードを検索できるので,特に社内であれば実装の production-ready な前例を豊富に参照できる.社内のライブラリの設定方法がわからない場合などもおすすめ.あるいは,同じシステムの中の他の部分の実装を踏襲するのも有効. |
社内 | ドキュメントサイト (Confluence,Notion など) | 似たようなことをやった人のドキュメントや特定のエラーの対処法などを調べるのに便利. |
社内 | ファイル共有サービス (Box,Dropbox など) | スライドなど探すのに便利. |
社外 | 常套手段.ブログや Web サイトなど. | |
社外 | 技術記事共有サイト (Zenn,Qiita など) | 常套手段. |
社外 | YouTube | 最近はニッチな分野でも動画素材が揃っている場合が多いので,YouTube でいちいち探してみるのも有効なことが多い. |
社外 | SNS (Twitter など) | 特に Twitter で逐一検索してみると有識者が発言していることがある. |
社外 | 書籍 | 常套手段.やはり他の媒体に比べ質が高い傾向がある. |
社外 | Google Scholar | 学術的内容なら論文を調べるのが確実.あるいは,広く人口に膾炙しているが,「学術的にきちんと述べた文献はないのか」を探すのも有効. |
言語
言語には大きく分けて,
- 日本語
- 英語
- その他の言語
があると思います.
言語に関してはつい日本語のみで探しがちですが,例えば Wikipedia でも日本語記事の記載は少ないが英語版を見ると豊富に書いてあるということが多々あります.英語に変換して各媒体で検索するのはとても有効です.
さらに,日本語・英語以外の言語で検索し,語学を勉強する or 機械翻訳で読む努力をするのも有効である場合があります.逆の立場になって日本語のみに良質な情報がある場合もあることを考えればこれは有効です.例えば私が印象に残っているのは,初等幾何学を熱心に学んでいる高校生が,中国語やロシア語の数学オリンピック代表選手の文献まで調査し勉強していたことです.余談ですが,幾何学は図があればある程度伝わるので,やりやすい分野なのかもしれません.
前例の量と質
量
前例は時間の許す限り調べるべきです.今の時代,情報が溢れているように見えて,手が届きやすい範囲には質が低いものしかないことが多いです.質が高い情報に辿り着くには,諦めずに探し続ける必要があります.「本当にこれだけなのか?」「自分が無知なだけではないか?」と自問して探してみるのがいいかもしれません.
また,ChatGPT などの AI に資料を食わせて質問してみると効率化できるかもしれません.
質
情報の質は言うまでもなく重要です.信頼できる情報としては,
- 数値的・客観的情報
- 1 次情報
- 開発者ガイドや公式ドキュメントなど
- 社内で OSS をカスタマイズしたプラットフォームなら,元となった OSS のドキュメント
- 玄人しか知らない単語による検索
- 信頼できる人の発信している情報
などがあります.
公式ドキュメントなどの 1 次情報を見るべきというのはよく言われますが,個人的に有効だと思うのは,その分野に詳しい人でなければ知り得ない単語による検索です.例えば,マニアックな話で恐縮ですが,初等幾何学では「シュタイナー線」や「フォイエルバッハの定理」などといった用語は,中学校などではまず習わず,熱心に勉強している人しか知り得ないので,例えばこれらの用語を Twitter で検索すると,詳しい人の発言がヒットします.また,その媒体で使える検索オプションがあればそれを活用するのもいいでしょう (Google 検索の "site:" で特定のサイト内で検索するなど).
そしてさらに,人を軸に探すことも有効です.ある分野に詳しい人というのは,自分の発言を十分に点検し,質に気をつけて発信していることが多いです.このような人のアウトプットを集中的に調べることで,質の高い情報を効率的に見つけることができます.
まとめ
前例を参照することは多くの場面において有効です.さまざまな媒体をさまざまな言語で検索することで多くの資料に行き着きます.その際,量と質には気をつけるべきです.できるだけ多く探すことが重要ですし,検索の仕方や見にいく情報源を工夫することで良質な前例に出会いやすくなります.
何かをするときに,自分一人で考え始める前に,前例を参照するように気をつけてみましょう.
参考文献
-
Wikipedia
-
先例 - Wikipedia
- 前例は古くから法源ともなりうると書いてありました.裁判所の判例とかはまさにそうですね.
-
Precedent - Wikipedia
- 英語版だと法的な先例について述べているようです
-
先例 - Wikipedia
-
Zenn / Qiita
- GitHub検索を利用するケースと検索方法
- やりたいことのやり方の調べ方
-
強い人達の調査/勉強法まとめ
- この記事は特に良かったです
- 調べ物はGoogle検索する前に、Perplexityを使ってみる
- 新卒1年目が考える、業務プログラミングでインプットを効率化する7つの習慣
-
ググる・検索力を上げるためのチートシート
- 検索用語の選択や言語を変える,検索オプションの使い方,情報源の質まで載っていました
-
YouTube
-
Twitter
-
本
-
その他
余談
「ひとまず前例を参照しよう」の前例があまり見当たりませんでした😇 諦めが早い可能性があります😇
「前例踏襲」で検索したり本を調べると,どちらかというと「前例を疑おう」的な話が多いように見えます👀
Discussion