伝わる技術記事を書くのって難しいですよね。今回は、私が技術記事を書くときに可能な限り実践していることを紹介します。
その記事において筆者と読者が持つべき課題感を共有する
私が技術記事を書くときは、記事の初めに筆者と読者の課題感を共有する、ということを大切にしています。お金をもらっていないときは雑に本題から入ってしまうこともありますが、お金をもらって記事を書く場合は必ず実施している取り組みです。
課題感とは何かというと、「どんな困りごとを解決しようとしたのか」ということです。
課題感を記事の中で真っ先に提示することで、「この記事の中に現れるすべての要素は、その困りごとを解決へと導く方法を解説するために書かれているはずである」という先入観を読者に持たせることができます。先入観という言葉は悪いニュアンスで使われることも多いですが、著者によって丁寧に関心を導かれた結果として得られた先入観は、長文を正しく読み解くための助けになります。
本記事のリード文として書いた「伝わる技術記事を書くのって難しいですよね」もまた、ひとつの課題感です。この一文があることで、読者は「この記事は伝わる技術記事を書くためのノウハウを教えてくれそうだな」という先入観を持ってこの記事を読むことができます。本当にそんなノウハウを伝えられているかは自信がありません。
そんなわけで、本題に入る前に、なぜその話題にたどり着いたのかを読者に説明する機会を設けましょう。可能であれば、多くの人が共感できる一般論をスタート地点にして、そこから派生する形で本来の課題感への話題を広げていくとよいでしょう。
実は論文の書き方に近い
実はこのノウハウは、論文の書き方を意識しています。
論文を書くときには、要旨（アブストラクト）や序文（イントロダクション）を初めに書くのが慣例です。要旨は論文全体の要約で、課題から結論までを通して説明します。その一方で、序文では、解決したい課題をはじめとして、その課題に着目した動機や背景などを説明します。これによって、論文を読む人は、論文の全てを読まなくても、どんな論文なのかを知ることができます。実験方法や結論が疑わしいと思った場合には本文を読み進めて詳細を確認するべきですが、概要を知りたいだけなら始めのほうを読めばよいのです。
前述した、私が技術記事を書く際のノウハウは、序文にあたります。筆者が何故その課題に取り組むのか、というモチベーションを読者に伝えることは、読者にとってもメリットがあると感じているため、この書き方を採用しています。記事によっては、最初の段落で簡単な結論まで解説している場合もありますが、要旨と近い手法ですね。本文はごちゃごちゃしているものの結論はシンプル、といった場合には要旨を意識したリード文を書くのもよいでしょう。
まとめ
よく練られた論文の文書構成は普通によくできているので、アカデミアにあまり馴染みがない方も、機会があったら論文の初めのほうを読んでみてください。学べるものがあるかもしれません。
というわけで、テクニカルライティングのノウハウのようなそうでもないようなお話でした。
Discussion