2019-04-11に更新

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

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

なぜバージョンが必要か

例えば同じ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

のように表示されます。


view_list [連載] エンジニアのブログ始め方
第1回 Markdownで書いてみよう
第2回 プログラム言語やフレームワークのバージョンを書こう
第3回 基本的な体裁 - 見出しと段落
第4回 プログラムのコードを書こう
第5回 すごく短い記事でも大丈夫

だら@Crieit開発者

Crieitの開発者です。 主にLAMPで開発しているWebエンジニアです(在宅)。大体10年程。 記事でわかりにくいところがあればDMで質問していただくか、案件発注してください。 業務依頼、同業種の方からのコンタクトなどお気軽にご連絡ください。 業務経験有:PHP, MySQL, Laravel5, CakePHP3, JavaScript, RoR 趣味:Elixir, Phoenix, Node, Nuxt, Express, Vue等色々

Crieitは個人で開発中です。 興味がある方は是非記事の投稿をお願いします! どんな軽い内容でも嬉しいです。
なぜCrieitを作ろうと思ったか

また、「こんな記事が読みたいけど見つからない!」という方は是非記事投稿リクエストボードへ!

こじんまりと作業ログやメモ、進捗を書き残しておきたい方はボード機能をご利用ください!

ボードとは?

関連記事

コメント