ドキュメント力を強化したい人のためのマニュアルライティング入門講座（EnterpriseZine）記事「ほんのすこし書き方に注意すれば、あなたのドキュメントはさらに分かりやすくなる！第二回」 における「概要」の説明がとてもわかりやすい内容になっています。
重要なことをざっくり伝える、それが概要の役割
「概要」は、その機能が何であるかを伝えたり、作業全体についてまとめたりしたものです。いわば、読み進める前に全体を俯瞰する全体図のような役割を果たすパーツです。
概要は、読み手に文章の全体を見渡してもらう役割を持っています。一度木でなく森全体を見てもらうことで、読み手がそれぞれの木の位置について考え、整理できるようにするのです。
背景説明は書かない
詳細な説明や技術的な内容に加えて、「概要」部分についつい書いてしまいがちなのが、経緯や背景説明です。
僕も経緯や背景説明を概要に詰め込んでしまい、これはいけない、と書き直したことが何度もあります。
今後も時々読み直したいくらい親切な内容になっています。今後の連載内容にも期待したいですね。
コメントする