ソフトウェア開発201の鉄則 原理34:一般:どの文書にも索引が必要だ

要旨

* ドキュメントには、文中に使用されている用語と、それらが使われている場所を示すリストである「索引」が必要である
* 読み手からしたら当然だが、作成者はそのことを忘れがちである
* ドキュメント中の情報の素早い検索、後の保守運用には索引は必須である
* 文章作成ツールの索引作成機能を有効に活用しよう

解説

原理33「どの文書にも用語集が必要だ」と、言いたいことは一緒だろう。

読み手のことを考えて文書を作成しよう。

実は一度も自分が作成したドキュメントの索引を作成したことは、ないが。