软件开发的201个原则
上QQ阅读APP看本书,新人免费读10天
设备和账号都新为新人

原则33 文档要有术语表

EVERY DOCUMENT NEEDS A GLOSSARY

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

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

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