わかりやすいブログを書くための Web ライティング技術

はじめに

一般的に、ブログは多くの人に読んでもらうために書かれています。しかし、技術ブログは必ずしもそうではありません。技術ブログは書き手がエンジニアであることが多く、そのような技術ブログにはより多くの人に読んでもらう以外にもうひとつの側面があります。

エンジニアはニッチなテーマであっても記録に残そうとする場合があります。なぜなら、エンジニアは技術的な勉強や挑戦を日々繰り返しており、その中で自分が理解できなかった点や、重要なポイントをアウトプットしておく場合があるためです。これは、将来的にもう一度迷わないようにメモとしての意味や、同じ問題を抱えるエンジニアへのアドバイスの意味があります。

このように技術ブログは、一般的なブログと同じように誰かの役に立つという意味では同じですが、より多くの人に見てもらいたい点で異なっています。エンジニアは何か問題があれば Google で同じ問題を既に誰かが解決済みではないかを調べようとします。つまり、車輪の再発明を可能な限り回避しようとします。そのため、技術ブログはエンジニア同士が Google を通して行うテキストベースのコミュニケーションであると言えます。

技術ブログの本質は同じ問題を抱える人との解決策の共有であり、そのためには分かりやすい技術ブログの書き方が求められます。このページでは、どのようにすれば分かりやすい技術ブログが書けるのかを以下の順で説明します。

  1. タイトルの決定
  2. 現状と背景の整理
  3. 問題点の定義
  4. 解決案一覧と比較検討
  5. 解決案の決定と理由
  6. 解決案のプロセス
  7. 解決案の注意点や例外

また、本ページではより分かりやすい文章を書くためにブログを論理的に書くための Web ライティング技術の記事もあわせて読むことをおすすめします。

^ 目次に戻る

タイトルの決定

あなたが何の技術ブログを書くのかタイトルを明らかにしてください。タイトルは、その記事を一言で表すもっとも重要なキーワードです。なぜなら、その記事を読むユーザはタイトルを見て読むべきかどうかの判断を行うからです。タイトルがシンプルで何を伝えたいのか表現できていない場合、ユーザはページを開いてくれないでしょう。また、タイトルが内容が異なっていたり誇張されていた場合、ユーザに不信感を与えてしまうため、慎重にキーワードを選定する必要があります。

書く内容は決まっていて、キーワードが決まらない場合は、執筆するための情報が不足している可能性があるため、ブログを速く書くための Web ライティング技術の記事を参照してください。どのような場合においても、情報は多いに越したことはありません。多すぎる情報は取捨選択すれば良いだけなので、まずは情報を集めて関連キーワードの中からタイトルにもっとも一致する主要キーワードを探してください。

タイトルを決める方法はもうひとつあります。それは、Google に実際のタイトルを入力してみてヒットした件数を調べる方法です。より件数が多いキーワードの方が一般的であるため、検索されやすいキーワードからアプローチします。これは、表記ゆれや正式名称ではないがデファクトスタンダードとなっているキーワードの選定によく使われます。また、Google ではそのキーワードと合わせて検索されているキーワード (共起語) も表示しています。それらのキーワードから、もっとも伝わりやすいタイトルを組み立ててください。

^ 目次に戻る

現状と背景の整理

次に現状と背景を整理しましょう。あなたは既に問題点や、それの解決方法まで思いついているかもしれません。しかし、読み手には現状のどこに問題があり、それらの背景について情報がありません。そのため最初に問題点を述べても、その問題がどこから現れたのか、どの程度のインパクトがあるのか、なぜ解決しなければならないのかがなどが分からずに混乱します。

現状と背景は何かの問題点を生み出している要因になっています。その問題により少なからず何か、または誰かが困っており、あなたはその問題点を解決しようと試みようとしているはずです。あなたは、なぜその問題を解決しようとしていますか。その問題は小さいものですか、それとも大きいものですか。解決することによって、どのようなメリットが生まれますか。解決するために必要な時間、人数、お金などのリソースはどれだけ必要ですか。解決することは、それらのリソースを投資に見合う費用対効果はありますか。読み手は、もしかするとその問題について何も知らないかもしれません。だからこそ、現状と背景の整理は読み手に問題を認識してもらうためのステップとして重要になります。

^ 目次に戻る

問題点の定義

上記の現状と背景の整理から見えてきた問題に対して問題点を定義します。つまり、解決するべき問題を明らかにすることでゴールを設定するプロセスです。問題点は漠然としたものであってはいけません。どの問題点を解決するのか、そしてどのような状態になれば問題点が解決したと判断するのか明確で具体的な基準を設けなければなりません。

問題点を正確に定義しなければ、何となく始まり何となく終わってしまい、実は問題はまだ残っていたなんてことは珍しくありません。問題点の定義とは、それをクリアすることで何かのメリットが明確にもたらされるものです。

問題点と解決することでもたらされるメリットは、タイトルに直結します。読み手となるユーザは、Google でその問題点、またはメリットに関するキーワードを使ってあなたのページに訪問します。そのため問題点とは具体的な一般名称で定義する必要があり、どのような状態を解決と定義するのか、または解決することでもたらされるメリットも具体的である必要があります。可能であれば、何らかの成果を数値に置き換えることをおすすめします。なぜなら、数値化することで効果が測定しやすく、前後比較によって成果が評価しやすいからです。時間、コスト、量、質など、客観的に測定できる指標が良いでしょう。主観的で恣意的な値は客観的な根拠に乏しく説得力がないため、避けたほうが良いでしょう。

^ 目次に戻る

解決案一覧と比較検討

問題点を解決する方法はひとつではないかもしれません。あなたは既にどの方法で問題を解決しようか考えているかもしれませんが、読み手にはなぜその方法で解決しようとするのかを提示する必要があります。

例えば、ある問題を解決するために解決案が3つあったとします。一般的に複数の解決案がある場合、それぞれプロセスや、コスト、リスク、リソース、影響度、範囲などが異なり、メリットとデメリットがあるはずです。なぜその解決策を選択したのか、読み手に比較検討した結果を提示しましょう。解決策を思いつく限り提示し、比較検討することは読み手に納得感を与え、情報の信頼性が増します。

ただし、コストやリスクが高すぎて現実的には実行できない案を、最初から選択肢に入れないことはアンフェアです。選択肢の中に含み、コストやリスクが高すぎて実行できない説明をした上で不採用にするべきです。選択肢の中には、これから紹介する解決案より良い方法があるかもしれません。しかしリソースは有限であるため、説明を加えた上で外した方が信頼感が生まれます。

メリットやデメリットも同様です。最初から解決案が決まっているからと言って、その選択肢だけ優遇するような恣意的なメリット・デメリットとして評価してはいけません。メリット・デメリットは、より優れた選択をするための材料であるため、公正な視点から評価するべきです。

^ 目次に戻る

解決案の決定と理由

解決案の比較検討が終われば、次は解決案の決定です。明らかに優劣がハッキリしている場合を除き、甲乙付けがたい解決案の中から絞り込むことは非常に難しい作業です。しかし、あなたの状況、環境、使えるリソース、許容できるリスク、優先度などから、絞り込むことは可能です。

読み手は、判断が難しい選択ほどその理由を知りたいと思います。客観的な状況を超えて、あなたの道徳、理念、思想、哲学、美学、好みによって決定することもあるかもしれません。しかし、それでもまったく構いません。ポイントは、ユーザがなぜそのような選択をしたのか理由を知りたいのです。その結果、支持されたり批判されたりするかもしれませんが、万人が支持する選択であれば、そもそも判断には迷ったりはしません。読み手には、あなたなりの考え方を説明すれば良いのです。

^ 目次に戻る

解決案のプロセス

解決案が決定したら、それを実現するまでの具体的なプロセスを提示します。プロセスには解決しなければならない小さなタスクがいくつもあり、そのタスクをクリアするには様々なリソースを必要とするはずです。解決案が複雑であればあるほど、タスクの数は増えていきます。そして、あるタスクを解決するためには、事前に複数のタスクをクリアしておく必要があるなどの相関関係も持ちます。

読み手には、それぞれのタスクをどの優先度順で、何のリソースを使って、どのようにしてクリアしていくのか、あるいはクリア出来なかった場合は後続にどのような影響がでるのかを明確に提示します。重要なポイントとしては、それが実現可能であることです。例えば、タスクをクリアするためには莫大なお金や、専門性の高い知識、特殊な技能など、用意や準備をすることが難しいリソースを当てはめることはできません。ある程度は読み手に考えてもらったり、手を動かしてもらったりすることは必要ですが、必要以上にリソースを強要してはいけません。

^ 目次に戻る

解決案の注意点や例外

最後に解決案の注意点や例外を、読み手に示しておくプロセスになります。タスクをクリアするにあたっての注意点や例外、もしくは読み手が支払わなければならない代償です。

これはどのような解決案を選択しても必ず発生するものです。すべてが解決する案であったとしても、何かしらのリソースを消費するはずです。読み手は、タダで何かが手に入ることはないと知っていますし、問題の解決案と同じ比率で注意点や例外にも意識を向けています。

この解決案を実行する、もしくは実行途中で注意するべき点や例外はなんでしょうか。読み手は何を代償として支払わなければならないのでしょうか。時間、自由、お金、リスクなど、何かしらあるはずです。それを読み手に提示することは、フェアな態度であることを示し、信頼感を与えます。

^ 目次に戻る

まとめ

このページではブログを論理的に書くための Web ライティング技術と、ブログを速く書くための Web ライティング技術を土台にして、説得力を増す文章の流れや組み立て方を紹介しました。この手法は、何かしらの設計を行う場面でもよく使われる書き方です。もしも文章の構成に迷った場合は、参考にしてみてください。