最後の章として、技術記事の書き方を学んでいきます。これは記事広告の書き方にもつながります。
そもそも技術記事はなんのために書くのでしょうか? 自分の知識の定着や、後から見るためのメモとして書くというのももちろんあります。それ以外にも『同じ悩みをもつ読者に解決策を提供すること』という大切な役割があります。
技術記事を書くときは、この読者の方を想定して、読者に分かりやすいように書いていきます。基本的には:
順番 | 項目 | 説明 |
---|---|---|
1 | What | この記事はなにを示すのか |
2 | Who | 誰のための記事か |
3 | Why | なぜこの記事を読むべきか |
4 | How | どのようにするのか。動作環境や手順、図など |
5 | When | いつ必要になる記事か |
という流れがよいかと思います。とくに、技術記事の場合は結論ファーストで書くと好まれるかと思います。記事の種類によって構成は変わりますが、基本的には上の流れでいいと思っています。
記事を書くときは、その記事を読む方はどんな人かをイメージして、読者のために書くよう心がけてみましょう。
技術記事を書いてみましょう。そのときは、読者をイメージして、読者に分かりやすいように書いてみましょう。
技術記事の書き方については、『エンジニアが技術ブログを始めるメリットと書き方、おすすめのブログサービス』でも詳しく書いています。あわせてご覧ください。
Webエンジニア&プロダクトマネージャ。 プログラミングで『ひとりで働く』を模索中。 三重の山の中で妻とこども、ネコとのんびり暮らしています。
Follow @zenizh