1
面向对象软件工程实践指南
1.2.5.5 5.5 词汇表的编写
5.5 词汇表的编写

词汇表用以解释所有在需求定义中了解到的关键词汇。它一方面可以起到规范词汇含义、避免误解的目的;另一方面,词汇表本身也可以作为下一阶段识别对象的依据。

词汇表中主要内容为各条词汇及其解释。其涉及的内容主要为术语定义,该节的格式如下:

定义:

此处定义的术语形成了该文档的基础。它们可以按任意顺序定义,但通常按字母顺序定义以便于查找。当术语名称和解释采用中文时,术语名称对应的英语表达也需要给出,因为后续类名的表达将采用英文词汇。

<一条术语>:在此处提供<一条术语>的定义。应提供读者理解此概念所需的全部信息。

<另一条术语>:在此处提供<另一条术语>的定义。应提供读者理解此概念所需的全部信息。

<一组术语>:有时,可以利用术语分组来提高可读性。例如,问题领域涉及与建筑项目的会计和建设两方面都相关的术语(当开发建筑项目管理系统时会出现这种情况),将两个不同子领域中的术语混在一起会使读者感到迷惑。为了解决这种问题,可以采用术语分组的方法。当提供分组术语时,应提供一段简短说明来帮助读者理解<一组术语>的含义。为了便于查找,同组内的术语应按字母顺序排列。

<第一组术语>:在此处提供<第一组术语>的定义,应提供读者理解此概念所需的全部信息。

<第二组术语>:在此处提供<第二组术语>的定义,应提供读者理解此概念所需的全部信息。