购买
下载掌阅APP,畅读海量书库
立即打开
畅读海量书库
扫码下载掌阅APP

原则35
对相同的概念用相同的名字
USE THE SAME NAME FOR THE SAME CONCEPT

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

举个例子:

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

不如写为:

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

Meyer,B.,"On Formalism in Specifications," IEEE Software ,2,1 (January 1985),pp.6-26. xRqLops8djzQg6tPSJg/X+BqhM9orcR+vwl+EPUDPY8WmHYt3mgsnhuOnp1X4ALT

点击中间区域
呼出菜单
上一章
目录
下一章
×