ITの技術系ブログ記事を書くときに気をつけたいこと

ITのエンジニアとして、技術の情報発信をするのは、自分の価値を高めるのにとても大事なこと。

で、ブログの記事にはどんなことを書けばいいか、自分が良くチェックするSE の雑記を分析して書いてみる。

記事の質

ブログの記事の質は色々あると思うけど、基準は「Googleで検索した記事が、そのまま答えになっている」記事にしたい。

例えば、最近仕事で、MS Azure上にSQL Server AlwaysOnを組むという時があり、手順をGoogleで検索したことがあった。

その際、Availability Group Listener in Windows Azure の設定というそのままズバリの参考記事があった。

このレベルでブログが書かれていると、とても助かるし、書いているエンジニアの人は仕事ができるんだろうなと思う。

タイトルが、求めている答えになっているようなイメージ。

信頼できるReferenceがある

これも必要不可欠。仕事では、何かを構築するとき、何を参考にして構築したかをシビアに要求される。そうしないと、お客様に説明責任を果たせないからだ。

Windows系の構築だったら、MSDNやMS社の開発者ブログの情報が信頼できるドキュメントなので、そこから引用されていることが不可欠。

Linux系は、個人のブログ記事を参考にすることが多いけど、各OSのマニュアルや、使用するミドルウェアのマニュアルの引用は必ず行うこと。

手順だけでなく、技術の意味も書く

インフラ系のブログで多いが、dockerやらchefやらのミドルウェアをインストールするとき、コマンドの羅列で終わっている事が多い。

個人利用の範囲では、とりあえず構築出来たらいいやでいいかもしれないが、仕事になったら、構築における一つ一つのパラメータまで踏み込んで理解しないといけない。

だから、コマンドの羅列だけではなく、そのコマンドがどんな意味をなしているか、設定のパラメータがどんな意味をなしているかまで調べて書く必要がある。

構築に試した環境を書く

最低限、どんな環境で試したかは書いたほうがいいと思う。OSはなにか、bit数は32bitか、64bitか、rubyのバージョンはなにかなど、それを読む人が手順を再現できるかどうかが変わってくる。また、読む時期によって、ソフトウェアのバージョンも変わってくるので、適宜読み替えないといけないこともある。

だから環境も必ず書く。

これくらいかな。