【初心者向け】技術ブログってどうやって書けばいいの?押さえるべきポイントを解説
インフラエンジニアの伊藤です。
新しく企業が技術ブログをオープンするにあたって、
必要なのはもちろんなんといっても「ブログを書く」ということ。
ただ、今までこういった試みをしたことがない場合は
「ブログを書くって難しい」と考えている人もいるのではないかなと思います。
ということで、今回は社内にも展開したブログの書き方について解説します!
ブログを書く上で押さえるポイント
日記ではなく情報を書く
技術ブログなので、あって当然なのですが、
ブログって何かなって考えたときに僕が思うのは「情報を提供すること」という結論に至ります。
例えば「僕が昨日オムライス食った」なんてことは誰も求めてないですよね。
有名人の日常ならそれだけでネタになりますけどね。。
こういった技術ブログにたどり着くのは、何か困ったときのはずです。
なので、「困ったことを解決出来ることが書いてある」べきだと考えます。
ということは…「僕が昨日オムライス食った」をもし記事にするのであれば、
「今話題の○○という洋食屋でオムライスを食べた」っていうような記事ならどうでしょう?
この場合、主語が「僕」から「お店」に変わりますよね。
ということは、僕というものを出しても何も解決にはならないけど、
お店のことが知りたい人であれば、どんなお店が知ることが出来て解決には繋がるのではないでしょうか。
これなら情報といえそうですよね。
せっかくなら困っている人を助けることが出来るブログでありたいものですね。
見やすさを考える
ここでいう「見やすさ」は2種類あります。
1つ目は視覚的な見やすさです。
書くにあたって、情報を書くのはいいんだけど、
それがわかりにくいものだったらどうしましょう。
例えば1行にずーっと改行もなく書くとか。
さっきの文章を1行にまとめます。
技術ブログなので、このことはあって当然なのですが、ブログって何かなって考えたときに僕が思うのは、「情報を提供すること」という結論に至ります。例えば「僕が昨日オムライス食った」なんてことは誰も求めてないですよね。有名人の日常ならそれだけでネタになりますけどね。。こういった技術ブログにたどり着くのは、何か困ったときのはずです。なので、「困ったことを解決出来ることが書いてある」べきだと考えます。
どうですか?見にくいですよね。。読む気が失せる!!
適度な改行とかはすごく大事です。
もう1つは「わかりやすさ」です。
技術ブログなので、専門的な言葉はたくさん出てきますが、そこをわかりやすく書くのが大事。
- なぜこうなったのか?
- 結論に至った理由は?
この辺りは明確に書かないと、エンジニアの方も納得してくれないですよね…
書き方の流れとしては、
- 困ったことがある
- じゃあどうすれば解決するのか?
- 何故そのことをするのか?
といったポイントを押さえているといいんじゃないでしょうか。
あとは細かいテクニック
ちゃんと見出しを付けるとか、途中に画像を用いるとか、URLは日本語のままにしないほうがいいとか…
割りと細かいところがありますが、これは割愛しちゃいます。
まとめ
特に長い文章だと、最後まで読んだときにどんな情報だったかがわからなくなることがあります。
なので、最後に簡単なまとめを書いておくと親切ですよね!
ブログを書く上で大事なことは、この2つになります。
- 情報を提供する
- わかりやすさを追求する
この2つを基本として、後は肉付け(細かなテクニック)を付けていくのがいいのではないでしょうか。
こうして、色んな情報を載せていきたいですね!
他にもブログについて書いている記事があるので、興味がある方はご覧ください。