プログラム言語やフレームワークのバージョンを書こう

技術的な記事を書く時、まずは使ったプログラミング言語やフレームワーク、ソフトウェア等のバージョンを忘れずに書くようにしましょう。

なぜバージョンが必要か

例えば同じPHPでも、PHP5.6とPHP7.3ではそもそもできることが異なっていたりします。

「PHP＋Laravelでこんなライブラリを使ってみました！」という記事を書いていたとしても、それが最新のPHP7.3＋Laravel5.8でしか動かないライブラリだった場合、記事を見た閲覧者が同じことを試して見ようとしても、PHP5.6＋Laravel5.5とかだったらそもそも動きません。なんでだろう…と悩んで時間を無駄に浪費してしまうことになります。

また、「こんなエラーが出たので解決した」という記事を書いた場合も、バージョンによってはそもそも発生しなかったり、解決方法が異なっていたりする可能性もあります。

「何の問題もなく簡単にできました！」と書いたのに、他の人が試してみるとエラーばかり出て全然進めない、GitHubのIssueを見てみると最新のバージョンだとエラーが報告されていてまだ解決していない…なんてこともあります。

どのように書けばいいか

プログラミング言語の話だけであれば最初に「PHP7.3を使っています」とでも書いておけば良いと思います。言語、フレームワーク、ライブラリと、色々なものを使っている場合はリスト表記で書いておくと良いでしょう。Markdownの場合リスト表記は下記のようにアスタリスクやハイフンで記述できます。

* PHP7.2
* Laravel5.8
* Bootstrap4.3

このように書くと

• PHP7.2
• Laravel5.8
• Bootstrap4.3

のように表示されます。