软件开发的201个原则阅读笔记06

第三十一条--不要忽视技术

软件工程技术日新月异。对几年内新的发展视而不见，是绝对不行的。软件工程的发展像波浪一样。每一波都会带来大量的“潮流元素”和流行语。尽管每一波只持续5~7年，但它们并不是简单地消失。其后每一波都是基于前一波的最好特征。(理想情况，“最好”应该指“最有效”，但遗憾的是，它往往指“最流行”。)

有两种方式可以让你紧跟技术潮流：阅读正确的杂志，和正确的人交谈。IEEE Software期刊就是一个很好的渠道，可以了解未来5年内可能有用的技术。PC Week、MacWorld等是学习硬件、常见商用工具和语言的好地方。要通过和人交谈来学习，就要找到正确的人。虽然

和同事交流很必要，但还不够。每年都应该努力参加1~2个关键会议。和参会者的交流，很可能比会议报告更重要。

第三十二条--使用文档标准

如果你的项目、组织或客户要求遵循一套文档标准，那就要遵循它。无论如何，永远不要抱怨标准，认为这是不需要的。所有我熟悉的标准，无论是政府标准还是商业标准，都提供了组织和内容方面的指导。

创新！即遵循标准，同时理智地执行。无论标准怎么规定，把你知道的应有的内容都包含进去。这意味着用清晰的语言来编写，意味着添加额外的有意义的组织层级。如果你的文档没有被要求遵循某个标准，至少应使用检查清单来检查是否有重大的遗漏。IEEE发布的文档标准，是我所知道的最广泛的可用软件文档标准之一。

第三十三条--文档要有术语表

当阅读文档遇到不懂的术语时，我们都会感到沮丧。但当我们在术语表中查到说明时，沮丧的情绪顷刻就烟消云散了。

所有术语的定义都应该以这样的方式编写：定义中使用的任何单词，都应该尽量避免再去术语表中查找含义。一种技巧是首先用日常用语解释，然后再使用术语解释。在术语的说明文字中，在其他地方定义的术语要用特殊字体(如楷体)标识。示例如下。

数据流图：是图形化符号，用于展示系统的功能、数据库、和系统有关的环境之间的信息流动。通常用于：结构分析，转换的组成(气泡表示)，数据流(箭头表示)和数据存储(两条平行线表示)，以及外部实体(三角形表示)。

第三十四条--软件文档都要有索引

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

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

第三十五条--对相同的概念用相同的名字

写小说时，保持读者的兴趣是第一目标；而在技术文档中，必须使用相同的术语来表示相同的概念，使用相同的语句结构来表述相似的信息。否则会令读者感到困惑，导致读者需要花费时间确认，在重述中是否有新的技术信息。应该把这个原则应用到所有技术文档的写作中，包括需求规格说明、用户手册、设计文档、代码中的注释等。

举个例子：

有三类特殊命令。常规命令有四种类型。

不如写为：

有三类特殊命令。有四类常规命令。