どのように記事を書くか

技術ブログを作ったら、あとは自由なタイミングで記事を書いていきましょう。とはいっても、どのように記事を書けばいいのでしょうか?ここでは、より分かりやすい記事を書く方法について学びます。

記事を書くときに重要なことは、誰のどんな悩みを、どのように解決するのか?ということです。すべての読者は、悩みを解決するために記事を読みます。例えばこの記事の場合は、「記事を分かりやすく書きたい」という悩みを解決するために読んでいると思います。これをふまえて、記事を書く前に次の3つを決めます。

  1. 読者は誰か
  2. どのような悩みをもっているのか
  3. 悩みをどのように解決するのか

これらを決めることで、文章の表現や記事の構成を作ることに役立ちます。例えば読者としてプログラミング初学者の方を想定したとき、できるだけ専門用語を使わないような表現にする必要が出てきます。また、悩みとその解決策を明確にすることで、分かりやすい構成を作るのに役立ちます。

本文を書くときにも、気をつけるべきことがあります。具体的には、次の7つのことに気をつけます。

  1. 結論を先に述べる
  2. 文章を短く切る
  3. 読者が分かる用語を使う
  4. 再現条件を示す
  5. 認識を揃える
  6. 図や表、コードを提示する
  7. 一次情報を引用する

例えば結論を先に述べましょう、ということはよく言われることだと思います。記事を読んでもらおうとして結論を先送りにしてしまうと、読者は別のページを探しに行ってしまうかもしれません。

関連記事

記事の書き方について詳しくは、「技術ブログの書き方」をご覧ください。ただ、書き方にこだわるあまり書けなくなってしまうよりも、まず書くことの方が重要です。記事を書き続けつつ、少しずつ書き方が身に付いていけばいいと思います。

記事の書き方を学んだところで、次はどのような記事を書くのか、つまり記事のネタを出す方法について学びましょう。

著者
Hiroki Zenigami

テクニカルライター。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。プログラミング教室を作るのが目標です。

スポンサーリンク

ブログをはじめよう

技術ブログの始め方を、たくさんの画像で分かりやすく解説しました。これまでブログをやったことがない人でも、エンジニアにとって重要なブログを今日から始められます。