開発ドキュメントを書くときは、読み手に配慮して、必要な情報を素早くかつ正しく得られるように、文章を工夫したいものです。有用なのが、要点を簡潔にまとめた「要約」と、内容をひと言で表した「見出し」です。この二つの上手な書き方を解説します。
関連講座:開発ドキュメントの悪文修正術[箇条書き]
開発ドキュメントを書くときは、読み手に配慮して、必要な情報を素早くかつ正しく得られるように、文章を工夫したいものです。有用なのが、要点を簡潔にまとめた「要約」と、内容をひと言で表した「見出し」です。この二つの上手な書き方を解説します。
余計な情報を徹底的に削ぎ落とす
要点を簡潔にまとめた「要約」は、文章を速く読めるようにするために必要です。上手な要約の書き方を解説します。
何について書いてあるかがすぐに分かるようにする
第2回では、文章の見出しに話を進めます。見出しのタイプには、大きく分けて「主題型」と「話題型」の二つがあります。
本文を読まなくても明確に意味をつかめるようにする
曖昧な表現は、見出しを付けるときに特に気を付ける必要があります。見出しは、本文を読まなくても一目で明確に意味をつかめるものでなければならないからです。