技術ブログを書く時に意識していること

この記事は mediba Advent Calendar 2018 14日目の記事です。

ご存知のかたもはじめましての方もこんにちは、株式会社 mediba のインフラストラクチャー部に所属している沼沢と申します。
普段は主に AWS を使ったインフラの設計構築運用をしています。

弊社はエンジニアのアウトプットの場として、エンジニアブログを運営しており、そこで自分は主に AWS について記事を書いています。

普段であれば、上記のブログ内か Qiita に記事を書くのですが、今回は技術的な内容ではなく、「技術ブログってなんかマサカリ飛んできそうで怖い」な人向けに技術ブログを書くときに意識していることや気を付けていることを書き連ねようと思うので、note で書くことにしました。note デビューです。

技術ブログを書く時に意識していること

1. みんな最初は書いたこと無い

技術ブログを書いたことが無い方々が、書かなくてはいけないことになったり、書くことを勧められた時にまず思うのは「技術ブログなんて書いたこと無いし…」ということではないでしょうか。

別にブログに限らないですし、当たり前のことではあるんですが、誰もが最初はやったことないんです。
生まれる前からやってましたという人は前世の記憶を持ったお方ぐらいでしょう。

なので、「書いたこと無いし…」というのは書かない理由にはなりませんので、書いちゃいましょう。

2. 内容が既に世に出ているものでも良い

1と同じく、書いたことが無い方々が次に思うのは、「何書いたって誰かしらがもう書いてるだろうし…何書けば良いのかわからない」ということではないでしょうか。

このご時世、No.1 で Only 1 なんて無理です。
内容なんてかぶってていいんです。

というのも、自分が調べる側だった時に、同じことが書いてある記事が複数あったら、「やっぱりそれであってるんだ」と思うことができませんか？
また、調べていると、自分が知りたいことと全く同じ状況で全く同じ検証している記事が全く見付からないことってありますよね。

なので、他で書かれていたって、書いて良いんです。
書いた記事が誰の役に立つかなんてわかりませんし、知る方法もありません。

それについては、「ゴミ記事が多すぎる問題」に対する私見 - Qiita が、個人的にはかなり良いことを書いてくれていると思うのでご参考まで。

3. 古いかどうかは関係ない

いざ何かについて書こうと決意した時に、その技術が世の中的に最新のものではないために、「こんな古いものの記事なんて誰も興味ないか…」と思い、書くことを躊躇してしまっていないでしょうか。

2と同じ話になってしまいますが、書いた記事が誰の役に立つかなんてわかりませんし、知る方法もありません。
古いものでも、もしかしたら誰かの役に立つかもしれません。
気にせず書きましょう。

4. 失敗したことすらも記事のネタにする

例えば何かを実現したくて検証したことがあって、それが思うように行かなくて頓挫した、という時に、それすらも記事にしてしまえば良い、ということです。

5. 公開後、SNS などでシェア

やっぱり見てくれると嬉しいですよね。
それがやる気に繋がったりして、より書きたくなることでしょう。知らんけど。

技術ブログを書く時に気を付けていること

ここからは、自分が技術ブログの内容で気を付けていることを書いてみます。

1. 前提があるなら書く

記事の内容で出てくるものは、バージョンや実行環境などを前提として記載しておくと親切です。

2. 用語の解説はあまり入れない

これは逆に不親切かもしれませんが、いちいち全ての用語に解説を入れていると記事がただただ長くなってしまうので、少し難しそうな用語の場合のみ、リンク先を貼ってあげるだけなどで良いと考えています。
わからない単語は OK, Google。

ただし、会社や自分だけの独自用語の場合はちゃんと解説しましょう。

3. 誤字脱字誤変換などは見つけたら修正

恥ずかしい誤変換などしていることは良くあります。
かといって公開前に細かくチェックする時間ももったいないので、とりあえず公開してしまって、気付いたら修正すれば良いと思います。

技術ブログを書くことで得られる副産物

最後に、技術ブログを書くことで得られる効果？について書きます。

1. 書く前より詳しくなる(気がする)

教えると自分も勉強になる、というのと同じで、どこかの誰かに伝えようとして書くと、ちゃんと前提やら方法やら結果やらを細かく書くようになるので、自分の知識としても定着しやすい(気がする)。

2. アウトプットしていると逆に情報も集まってくる

例えば、公開したブログでコメントを許可していると、通りすがりの親切なオジサンが間違いを指摘してくれたり、改善点をつぶやいてくれたりすることもあるでしょう。
(という光景を Qiita などで見かけるだけで、体験談ではないです。)
コメントでマサカリが飛んできた場合はスルーするも良し、臆せずに指摘内容について再度検証して別記事にしてやるも良しです。

また、とある分野のことばかり書いていると知らず知らずのうちに知名度が上がって、イベントなどで声をかけてもらえることもあるでしょう。
例えば AWS 界隈では、個人ではないですが、AWS のことを検索するとほぼ確実に1ページ目に何かしらの記事がヒットし、「某ブログの会社」なんて呼ばれて絶大な支持を集めている会社もあります。

3. 自己アピールに使える

技術系のカンファレンスや勉強会に登壇する機会があったり、転職するときなどに、自己紹介として「こんなこと(技術)やってます」が伝えやすいと思います。

あとがき

自分も会社の技術ブログが始まるまでは書いたことが無かったし、書いてる本数も大したことないので、偉そうに書いているように見えるかもしれません。
ですが、書いたことがない方々、これから書こうと思っていたけど悩んでいる方々が、この記事を読んで技術ブログを書く勇気を出していただけたら良いなと思います。
そして、世の中に更に情報が増え、それがまた誰かの役に立つと信じています。