原则34　软件文档都要有索引

EVERY SOFTWARE DOCUMENT NEEDS AN INDEX

这个原则对于所有的软件文档的读者来说都是不言自明的。令人惊讶的是，很多作者并没有意识到这一点（想想，每个作者有时也是读者）。索引通常是文档所使用的所有术语和概念的列表，包括一个或多个页码，用于标记术语或概念在哪里被定义、使用或引用。对于需求、设计、编码、测试、用户的和维护文档来说都是如此。索引可以帮助读者快速查找信息，对于文档后续的维护和优化也很重要。

现代文字处理软件提供将索引引用嵌入正文的指令，这使创建索引变得十分简单。文字处理软件还会对索引进行编译，然后按字母顺序排列，并将结果输出。大多数CASE工具也能生成可用的索引。