原則34　軟件文檔都要有索引

EVERY SOFTWARE DOCUMENT NEEDS AN INDEX

這個原則對于所有的軟件文檔的讀者來說都是不言自明的。令人驚訝的是，很多作者并沒有意識到這一點（想想，每個作者有時也是讀者）。索引通常是文檔所使用的所有術語和概念的列表，包括一個或多個頁碼，用于標記術語或概念在哪里被定義、使用或引用。對于需求、設計、編碼、測試、用戶的和維護文檔來說都是如此。索引可以幫助讀者快速查找信息，對于文檔后續的維護和優化也很重要。

現代文字處理軟件提供將索引引用嵌入正文的指令，這使創建索引變得十分簡單。文字處理軟件還會對索引進行編譯，然后按字母順序排列，并將結果輸出。大多數CASE工具也能生成可用的索引。