今日も8時間睡眠
8時8分888文字。何それ?
【広告】君の名は。

「こうしよう」の方が、アドバイスとしては良い

これ読みました。

技術書、それも売れるやつを書きたい人へ、編集者からのアドバイス | ツチノコブログ

IT系の売れる技術書の書き方に関するアドバイスなんですけど、もっと広く、学術系の本を書く場合にも役立つ話が書かれています。例えば、「用語の解説だけで理解してもらうのは難しいから、それが必要となる背景も書こう」というのは、読者として苦しめられた経験のある人が読めば、反面教師的なアドバイスとしてすごく響くと思うんですよね。

僕は数学の本をよく読んでいましたが、数学は「定義・定理・証明」の流れで文章が進んでいきます。「定義」の部分で、「それは何か」は語られるのですが、「なぜそれを考えるか、なぜそれが必要なのか」まで語られる本というのは少ないです。だから、だいぶ後になるまで必要性が理解できず、モヤモヤすることが多かったんですよね。なので、「用語の解説だけで理解させるのは難しい」というのは、よくわかります。

上のリンク先の文章は、全体的に具体的でわかりやすいなぁと思います。ただ、各章についている「まとめ」がちょっと気になります。

例えば、1つ目の「わかりやすく伝えるための工夫」のまとめは、次のようになっています。

わかりにくい解説のアンチパターンを避ける
いわゆる「上手な文章」を書く自信がなくても大丈夫

はたしてこれはまとめでしょうか。「ダメな例を避ける」「上手な文章は不要」とだけまとめられても、「わかりやすく伝えるための工夫」にはつながりにくいんじゃないかと思います。「これはダメ、これは不要」というより「こうしよう」の方が、アドバイスのまとめとしてはいい気がします。

僕なら、この章のまとめは次のように書きます。

  • (用語の説明だけでなく)その用語が「必要になる背景」まで説明しよう
  • (図や表だけで説明終了ではなく)図や表は「文章での説明」の補足として使おう
  • (その技術が何かだけでなく)その技術が「どんな場面で」必要かも説明しよう

丸カッコの中は、あってもなくてもいいです。「こうしよう」というまとめのほうが、読んだ人が今後起こす「アクション」につながりやすくなるんじゃないかと思います。

共有:
広告
日付の近い記事
関連しない記事(ランダム)
姉妹サイトなど