全2594文字

 開発ドキュメントの文章に求められる条件の一つは、速く読めることです。ITの現場では、読み手のエンジニアが開発ドキュメントの文章をじっくりと読解している余裕はありません。そのため開発ドキュメントを書くときは、読み手に配慮して、必要な情報を素早くかつ正しく得られるように、文章を工夫したいものです。

 文章を速く読めるようにする上で有用なのが、要点を簡潔にまとめた「要約」と、内容をひと言で表した「見出し」です。要約と見出しの出来で、読みやすさは大きく変わります。

 そこで今回は、要約と見出しの書き方について解説します。