読み手が納得する開発ドキュメントを作るにはどうすればよいのか。本特集では日経SYSTEMSの過去記事を再編集。実用性の高い実践ノウハウを5日間で習得しよう。

 文章や図表をうまく書くには生まれ持ったセンスが必要──。そんなふうに考えたことはないだろうか。

 確かに、語彙力や図表の色遣いのようなスキルは、一朝一夕には身に付かない。しかし、そうしたスキルの有無に関係なく、ドキュメント作成に必要な作業を1つずつ確実にこなすことで、分かりやすく説得力のある文章や図表を作成できる。

 ここでは、分かりやすく説得力のある文章や図表を書くうえで特に重要な鉄則を解説する。取り上げる鉄則は、(1)最初に構成を考え論理性を高める、(2)意味のあいまいさを排除する、(3)文章と図表をバランス良く用いる、(4)レイアウトの工夫で視認性を高める、(5)無駄取りと切れ目でリズムを整える──の5つである。今回はこのうち(1)~(3)までを解説する。順に見ていこう。

分かりやすさや説得力を高める表現の鉄則
ここでは、すぐに実践できることを取り上げる。最初は負担に感じるかもしれないが、習慣化することでそれほど手間がかからなくなるはずだ
[画像のクリックで拡大表示]

鉄則 1
構成を考え論理性を高める

 結論を先に書く注1──。ドキュメントの鉄則として、誰しも一度は聞いたことがあるだろう。読み手にとっては、最初に結論を示されたほうが理解しやすい。ところが「最初に結論を書いていないドキュメントが、ITの現場で散見される」(IT教育コンサルタントのA氏)。

 原因はいくつかあるだろう。例えば、ストレートに結論を言うことに心理的な抵抗を感じ、あえて結論をはっきり書かないケース。そのほか、そもそも結論がはっきりしないままドキュメントを書き始めているケースもある。その場合、書きながら結論を考えることになる。

 いくつかの原因があるが、根本的な原因は、書き始める前に論旨構成を決めていないことである。書きながら同時に論旨構成を考えているのだ。「論旨構成の要である結論をあいまいなまま書き始めれば、当然ながら結論は最後になる」(前出のA氏)。「論旨構成を考える」「書く」という2つの作業はどちらも単純ではないので、分割して実施すべきである。

 論旨構成を事前に考えることの効果は、結論が先に来るので分かりやすくなる、というだけではない。「結論の論拠や補足事項も整理して提示することになるので、分かりやすさや説得力が高まる」(A氏)。

結論と論拠を見いだし構成を検証

 では、どのようにして論旨構成を決めればよいのだろうか。その作業は、3つの大きなステップに分けることができる。