👓

技術ブログなどの第三者が書いた記事の利用方法を考える

2022/02/05に公開

技術ブログをうまく使っていこう

先ほど開発チームに新しく入ってきたメンバー用にnextjsのセットアップ手順をまとめたのですが、自分で書いてみて、第三者がまとめた設定手順には弊害もあると思ったので、うまい利用方法について検討します。

今回は特にnodejsのnpmモジュールについてまとめた記事をサンプルとして記載していますが、その考え方は他の言語やパッケージでも有効だと思います。

技術の領域は進化がとても早いです。記事作成時には最新だった情報も、時間が経つと古くなっていることが多くあります。紹介されているツールにバージョンアップがあった場合などは、手順通りに実行しても動かないことがよくあります。

また、内容を理解せずに手順通りにコピペで構築することによって、内容を理解していないコードや設定がプロジェクト内に増えていくことになり、メンテナンスのコストが高くなってしまいます。

下記のように、網羅的に全体像を記載している記事は、概要を掴むための流し読みにお勧めです。

さっと見渡してみて、このようなツールがあるんだな〜、こういう手順でやるんだな〜、というような感じで流してしまっていいのかなと思います。

第三者の書いた技術記事は、作成者の個人的な慣習をもとに記載されているものなので、もっといいツールや方法がある場合があります。

ツールの場合は、まずはgithubのstar数と、モジュールのdownload数を確認しましょう。

今回はhuskyを例として取り上げます。

huskyは特に問題なさそうですが、このstar数や、download数が不自然に少ない場合は注意が必要です。また、下記のようなサービスで代替するツールとの比較を行うことがお勧めです。

このサービスでは、代替ライブラリとのdownload数の推移の比較をすることができます。このようにツール名を押すと、似たようなサービスが表示されるので、+を押して追加すると

このように代替ツールとの比較を行うことができます。

もし、自分が使おうとしているツールのダウンロード数が他のツールと比べて落ちている場合は、他のツールを検討してみてもいいかもしれません。

またツールではなく、コードの書き方のような記事の場合は、stack overflowなどの質問に対する回答形式のサービスを利用する方が、さまざまな実現方法を比較し、他の人からの評価も加味した上で実現方法を選ぶことができてお勧めです。

記事内には、公式ページへの導線が記載されていることが多いので、記事の内容を見渡してざっくりと手順を把握した後に、できる限り公式ページを見てダブルチェックを行うことをお勧めします。

公式ページの中で特に、Usage、Get Started、Quick Start、Documentationなどと書かれた箇所に必要な情報が入っていることが多いです。

今回参考にしているhuskyについては、公式のgithubからdocumentationの記載を見つけ、

こちらのrecommendにある記載を見つけました。

基本的にはこの公式の記載をもとに設定しつつ、補足情報として技術ブログの記事を使うことをお勧めします。

さて、この記事では、技術ブログなどの第三者が書いた記事とのうまい付き合い方について考えて見ました。情報を鵜呑みにしてしまうよりも、考えながら参考にしていく方が、良い結果が得られることが多いと思うので、ぜひ試して見てください！