华中科技大学
机械学院
数字制造与智能装备研究中心
软件设计及验收规范
2005年3月2日制定
目录
1制定本规范的目的及规范适用范围.....................................................3
2软件设计规范.........................................................................................3
2.1引言......................................................................................................................3
2.1.1定义................................................................................................................3
2.1.2参考资料........................................................................................................3
2.2程序系统的结构..................................................................................................3
2.3程序1(模块1)设计说明................................................................................3
2.3.1程序功能、性能等描述................................................................................3
2.3.2接口及输入、输出项....................................................................................4
2.3.3算法、流程逻辑............................................................................................4
2.3.4测试计划........................................................................................................4
2.3.5其它................................................................................................................4
2.4程序2(模块2)设计说明................................................................................4
3软件验收规范.........................................................................................4
1制定本规范的目的及规范适用范围
“软件设计及验收规范”旨在规范“数字制造与智能装备研究中心”计算机软件的开发与验收工作,该规范适应于本中心研究人员所从事的计算机软件开发和计算机软件验收,请本中心研究人员共同遵守、执行。
2软件设计规范
本中心研究人员开发计算机软件时,应遵守下列设计规范。
2.1引言
2.1.1定义
列出本文件中用到专门术语的定义和外文首字母组词的原词组。
2.1.2参考资料
列出有关的参考资料,如:
a . 属于本项目的其他已发表的文件;
b . 本文件中各处引用到的文件资料,包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。
2.2程序系统的结构
用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称和它们之间的层次结构关系。
2.3程序1(模块1)设计说明
从本章开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。
2.3.1程序功能、性能等描述
给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻?是否子程序?是可重入的还是不可重入的?有无覆盖要求?是顺序处理还是并发处理等)。说明该程序应具有的功能,可采用IPO 图(即输入一处理一输出图)的形式。说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。
2.3.2接口及输入、输出项
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构(数据库、数据文卷)。
给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。
2.3.3算法、流程逻辑
详细说明本程序所选用的算法,具体的计算公式和计算步骤。用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。
2.3.4测试计划
说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
2.3.5其它
根据需要,说明本程序的存储分配、运行中所受到的限制条件、在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题等。
2.4程序2(模块2)设计说明
用类似2.3的方式,说明第2个程序乃至第N 个程序的设计考虑。
......
3软件验收规范
本中心研究人员完成计算机软件开发后,中心将根据“软件验收规范”组织软件验收小组对所开发的软件进行测试、验收,并出具测试报告,具体测试内容如下。
软件是否符合“软件开发规范”要求; 设计文档是否完整、正确; 源程序代码是否完整、正确; 根据2.3.4测试计划,对软件进行测试;
软件验收后,应提供:
软件测试报告(由测试小组完成) 软件设计文档(由软件开发人员完成) 源代码清单(由软件开发人员完成)
华中科技大学
机械学院
数字制造与智能装备研究中心
软件设计及验收规范
2005年3月2日制定
目录
1制定本规范的目的及规范适用范围.....................................................3
2软件设计规范.........................................................................................3
2.1引言......................................................................................................................3
2.1.1定义................................................................................................................3
2.1.2参考资料........................................................................................................3
2.2程序系统的结构..................................................................................................3
2.3程序1(模块1)设计说明................................................................................3
2.3.1程序功能、性能等描述................................................................................3
2.3.2接口及输入、输出项....................................................................................4
2.3.3算法、流程逻辑............................................................................................4
2.3.4测试计划........................................................................................................4
2.3.5其它................................................................................................................4
2.4程序2(模块2)设计说明................................................................................4
3软件验收规范.........................................................................................4
1制定本规范的目的及规范适用范围
“软件设计及验收规范”旨在规范“数字制造与智能装备研究中心”计算机软件的开发与验收工作,该规范适应于本中心研究人员所从事的计算机软件开发和计算机软件验收,请本中心研究人员共同遵守、执行。
2软件设计规范
本中心研究人员开发计算机软件时,应遵守下列设计规范。
2.1引言
2.1.1定义
列出本文件中用到专门术语的定义和外文首字母组词的原词组。
2.1.2参考资料
列出有关的参考资料,如:
a . 属于本项目的其他已发表的文件;
b . 本文件中各处引用到的文件资料,包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。
2.2程序系统的结构
用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称和它们之间的层次结构关系。
2.3程序1(模块1)设计说明
从本章开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。
2.3.1程序功能、性能等描述
给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻?是否子程序?是可重入的还是不可重入的?有无覆盖要求?是顺序处理还是并发处理等)。说明该程序应具有的功能,可采用IPO 图(即输入一处理一输出图)的形式。说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。
2.3.2接口及输入、输出项
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构(数据库、数据文卷)。
给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。
2.3.3算法、流程逻辑
详细说明本程序所选用的算法,具体的计算公式和计算步骤。用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。
2.3.4测试计划
说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
2.3.5其它
根据需要,说明本程序的存储分配、运行中所受到的限制条件、在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题等。
2.4程序2(模块2)设计说明
用类似2.3的方式,说明第2个程序乃至第N 个程序的设计考虑。
......
3软件验收规范
本中心研究人员完成计算机软件开发后,中心将根据“软件验收规范”组织软件验收小组对所开发的软件进行测试、验收,并出具测试报告,具体测试内容如下。
软件是否符合“软件开发规范”要求; 设计文档是否完整、正确; 源程序代码是否完整、正确; 根据2.3.4测试计划,对软件进行测试;
软件验收后,应提供:
软件测试报告(由测试小组完成) 软件设计文档(由软件开发人员完成) 源代码清单(由软件开发人员完成)