软件研发规范.docx
《软件研发规范.docx》由会员分享，可在线阅读，更多相关《软件研发规范.docx（18页珍藏版）》请在冰点文库上搜索。
软件研发规范
一、前言
二、文档规范篇
1.概述
2.文档与软件开发过程
3.文档规范
3.1.需求规格说明
3.2.概要设计说明
3.3.详细设计说明
3.4.数据库设计说明
3.5.测试计划
3.6.测试设计说明
3.7.测试用例说明
3.8.测试总结报告
3.9.系统指南
3.10.用户操作手册
三、编码规范篇
1.概述
2.编码规范
2.1.命名规范
2.2.编程结构描述
2.2.1.注释
2.2.2.函数注释
2.2.3.条件执行语句if…else
2.2.4.重复执行while和跳转语句goto
2.2.5.书写格式
2.2.6.字体
2.2.7.数据对象的国际化
3.软件开发规范的控制
第一章前言
第二章文档规范篇
1.概述
软件生存期的所有阶段都要求编制文档。
因此文档编制和维护是必需的并且从软件的概念阶段连续作用到它废止。
文档编制开始于软件项目的初始阶段，并贯穿于软件的设计、开发、测试、安装、使用、修改和增强。
文档的编制是任何软件开发项目成功的基础，并且文档的产生需要有时间、人工和资金的支撑。
管理的职责是保证这些资源有效地利用重要文档的标识以使软件产品成功开发并提高质量。
本章重点在于规定在软件开发阶段各文档的编制规范。
2.文档与软件开发过程
阶段
文件
需求分析
设计
实现
测试
运行与维护
项目开发计划
——
需求规格说明
——
概要设计说明
——
详细设计说明
数据库设计说明
——
测试计划
——
——
测试总结
——
系统指南
——
——
——
用户操作手册
——
——
——
开发进度月报
——
——
——
——
项目开发总结
——
3.文档规范
3.1.需求规格说明
软件需求规格说明书
1.引言
1.1.项目名称
1.2.项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.3.相关资料、缩写语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准，缩写词和相关名词定义）
2.项目概述
2.1.被开发软件的一般描述
（被开发软件的主要组成部分，相互联系和外部接口，可用系统流程图的层次结构描述）
2.2.被开发软件的功能
（简述被开发软件的功能）
2.3.实现语言
（列出所采用的编程语言）
2.4.用户特点
（描述最终用户具有的受教育水平、工作经验及技术专长）
2.5.假定条件与约束限制
（尽量列出开展本项目的假定和约束，例如：
经费限制，开发限制，设备条件，用户现场环境准备等）
3.业务流程
（描述项目的业务流程，可结合系统流程图进行描述）
4.数据描述
4.1.原始数据描述
4.1.1.静态数据
4.1.2.动态数据
4.2.数据流向图
4.3.数据概念模型和描述
5.功能需求
5.1.功能描述
（描述该软件功能及使用方法；列出与功能有关的背景资料）
5.2.输入要求
a）输入数据的描述，包括输入源、数量、度量单位和精度
b）操作控制需求，包括输入格式、数据类型、精度和范围自动检验等
c）输入设备接口资料，包括设备型号、数量
5.3.处理要求
a）输入数据有效性检查手段
b）操作顺序和处理过程
c）非正常情况的响应，如溢出、通讯故障、错误处理等
d）输出数据有效性检查手段
5.4.输出要求
a）输出数据的描述，包括目的地（存储媒体和用途）、数量、度量单位和精度
b）非法数据的处理
c）指明引用的输出设备接口资料，包括设备型号和数量
6.界面要求
6.1.报表格式
6.2.图形要求
6.3.输入输出要求
7.接口要求
（描述与本系统相连的系统的接口的数据格式，数据交换协议，接口功能等）
7.1.硬件接口
a）软件产品与系统硬件设备之间每一接口的逻辑特点
b）硬件接口支持的设备
c）软件与硬件设备接口之间以及硬件接口与支持设备之间的约定
7.2.软件接口
描述该软件产品与其他有关软件的接口关系，并指出这些软件的名字和作用。
7.3.通讯接口
说明各种通讯接口及协议。
8.性能要求
8.1.数据精确度
（例如：
数据内部精度，外部显示精度）
8.2.数据量
8.3.时间特性要求
（根据所开发系统的特点，规定系统对时间的特性要求。
例如，系统响应时间，界面更新处理时间，数据转换与传输时间）
9.运行环境要求
9.1.网络和硬件设备平台
（网络拓扑图及设备类型描述）
9.2.操作系统平台
9.3.数据库系统平台
9.4.编程工具
9.5.其他支撑软件
10.其他专门需求
10.1.安装与操作
10.2.安全与保密
10.3.维护服务
3.2.概要设计说明
概要设计说明书
1.引言
1.1.项目名称
1.2.项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.3.相关资料、缩略语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准，缩写词和名词定义等）
2.概要设计
2.1.软件体系结构
（用图来表示软件系统的总体结构框架，并针对其进行描述）
2.2.基本设计概念和处理流程
2.3.软件结构
2.3.1.子系统划分
a）子系统清单
b）各子系统功能描述
2.3.2.程序模块划分和功能分配
（包括前端程序模块和后端存储过程的划分和功能分配）
a）子系统及程序模块清单
b）各程序模块功能描述
c）功能——模块对照表
d）模块——数据实体对照表
2.3.3.人工处理过程
（描述不能完全自动处理，需人工处理的过程。
）
3.软件模块的物理分布
（根据系统网络结构，描述软件模块在各个设备上的物理分布）
4.接口设计
4.1.与外系统的接口
4.2.内部接口
5.用户界面设计
（和用户交互的最终界面在《详细设计说明》中设计解释，在此应对系统的主界面和界面风格进行设计和描述）
6.数据结构和算法设计
6.1.程序中数据结构描述（描述系统中主要的数据结构和模块间共享的数据结构）
6.2.主要算法设计
7.出错处理设计
7.1.出错信息
（用表的方式说明可能的出错和故障情况出现时，系统输出信息、形式和含义）
7.2.出错处理措施
8.安全保密设计
（描述安全保密方案，权限设置，保密算法，软件的实现方法等）
3.3.详细设计说明
详细设计说明书
1.引言
1.1.项目名称
1.2.项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.3.相关资料、缩略语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准，缩写词和名词定义等）
2.程序结构
2.1.程序结构图
（主要表示程序之间的调用关系）
2.2.程序文件清单
子系统名
程序文件名
运行平台
编程语言
简要描述
3.程序设计说明
程序文件名子系统名
编写者编写日期
第次修改修改人修改日期
程序功能描述：
输入输出项：
主要数据结构：
存取的数据库表和字段：
调用的其他程序：
调用的公共函数库或公共函数：
算法：
逻辑流程图：
测试要点：
4.用户界面设计说明
4.1.用户界面图
（可制作有关用户界面图集的附录参考）
4.2.用户界面与模块关系表
用户界面名称
用户界面编号
隶属子系统
相关模块名称
简要名称
3.4.数据库设计说明
数据库设计说明书
1.引言
1.1.项目名称
1.2.项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.3.相关资料、缩略语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准，缩写词和名词定义等）
2.约定
（数据库中各种元素的命名约定。
例如表名，字段名的命名约定）
3.数据库概念模型设计
3.1.数据实体——关系图
3.2.数据实体描述
（数据实体中文名、数据库表名、数据实体描述）
3.3.实体关系描述
（描述每一个实体间的关系）
4.数据库逻辑模型设计
4.1.实体——关系图（不含多对多关系）
4.2.关系模型描述
4.3.数据视图描述
（用标准SQL语言中创建数据视图的语句描述）
4.4.数据库一致性设计
（用标准SQL语言中创建表的语句描述）
5.物理实现
5.1.数据库的安排
a）说明是否采用分布式数据库，数据库表如何分布
b）每个数据库服务器上建立几个数据库，其存储空间安排
c）数据库表的分配方法
5.2.安全保密的设计
（用户角色划分方法，每个角色的权限）
3.5.测试计划
测试计划
1.引言
1.1.项目名称
1.2.测试计划名称
1.3.项目背景和内容概要
（项目的委托单位、开发单位、主管部门、与其它项目的关系，与其他机构的关系等）
1.4.相关资料、缩略语、定义
（相关项目计划、合同及上级机关批文，引用的文件、采用的标准，缩写词和名词定义等）
2.测试过程
2.1.测试目标
a）测试目的
b）测试类型
c）测试级别
2.2.测试分工
（分配参与到测试工作中所有人员的职责，如谁负责生成测试代码，谁负责进行具体的测试工作等）
2.3.测试步骤及方法
（采用《测试过程控制程序》中规定的那些步骤和相应的测试内容及方法）
2.4.测试通过标准
（由项目负责人组织制定，如：
执行完毕没有系统错误；满足性能要求；产生了预期结果等）
2.5.修正错误并重新测试的步骤与要求
（填写错误报告表、修正程序错误、修改设计说明，重新测试等）
3.测试小结
3.1.测试环境要求
（外部接口的设置；准备必要的资源）
3.2.测试用例的简单描述
（如测试用例命名规则，需要的测试特性）
3.3.需求跟踪
（创建一个跟踪矩阵来描述功能需求与测试用例之间的关系）
3.6.测试设计说明
3.7.测试用例说明
测试用例说明
1.序号
2.测试用例的名称
（按照测试计划和测试设计给定的测试用例名称，例如：
LN0102可表示辽宁电力局项目，第01个测试要点的第02个测试用例）
3.测试用例的目的
（给出此测试用例要验证的功能，既给出针对的测试断言）
4.测试用例的输入
（测试用例的输入项详细描述）
5.期待的输出
（测试用例的程序预期输出项详细描述）
6.测试方法
（如何执行测试用例）
7.实际的输出
（测试用例执行后进行填写）
8.相关测试用例
（与本测试用例相关的测试用例，比如对统一需求进行验证的所有测试用例及其关系）
3.8.测试总结报告
测试总结报告
1.引言
1.1.编写目的
1.2.背景说明
（被测试系统的名称，任务提出者，开发者，用户等。
指出测试环境与实际运行环境之间的差异以及其对测试结果的影响）
2.测试概要
（用表格的形式表示每一个测试项的标识与其内容，指出实际测试内容与测试计划的差别以及更改的原因）
3.测试结果
（每一个测试项的每一个测试用例执行后的实际结果与与其结果向比较，说明所发现的结果）
4.对软件功能的结论
（对软件的每一个功能，给出相应的结论）
a）通过测试检验的能力
b）发现的限制和缺陷
5.分析总结
（通过以上几个步骤，对软件进行总体上的评价，说明限制和缺陷）
6.测试资源的消耗
（在测试工作中的资源消耗，包括人员，时间等）
3.9.系统指南
系统指南
1.引言
1.1.编写目的
1.2.背景
2.系统功能
2.1.系统简介
2.2.系统功能
2.3.系统特性
3.运行环境
3.1.网络结构
3.2.硬件设备
3.3.支持软件
3.4.运行环境要求
4.系统安装
4.1.安装准备
4.2.安装过程
4.3.系统初始化
5.出错处理
3.10.用户操作手册
第三章编码规范篇
1.概述
一个好的软件产品是众多程序设计和实现人员共同努力，协同开发的结果，而源程序代码的逻辑简明清晰、易读易懂是好程序的一个重要标准。
本章重点规定在程序编码过程中所有程序人员都应当遵守的规范。
2.编码规范
2.1.命名规范
2.1.1.文件名
文件名采用小写，使用能够表达文件功能的词汇或词组进行命名。
如：
loop.c表示此文件中的内容与循环操作或循环优化过程有关。
2.1.2.函数名
函数名应能够基本表达函数功能，采用字母的词组，可用下划线连接。
如：
sim_fetch_register表示模拟从寄存器中读取数据的过程。
2.1.3.变量名
变量名应尽量能表达此变量的用途，采用字母。
如：
err_no表示此变量用作对错误号的纪录。
2.1.4.表名
表名以r_开头，能表明表的内容。
如：
r_stu_name表示此表用作纪录学生姓名。
2.1.5.视图名
视图名以v_开头，应尽量体现各视图的功能。
2.1.6.触发器名
触发器名为相应的表名加上后缀，Insert触发器加‘_i’，Delete触发器加‘_d’，Update触发器加‘_u’，如：
r_bch_i，r_bch_d，r_bch_u。
2.1.7.存储过程名
存储过程应以'sp_'开头，后续部分主要以动宾形式构成。
2.1.8.命名的其他注意事项
以上命名不得超过29个字符的系统限制。
数据对象、变量的命名都应采用英文字符，禁止使用中文命名。
2.2.编程结构描述
2.2.1.注释
a）注释以英文为主
b）注释尽可能详细、全面
c）视情况采用单行注释和多行注释的形式
d）简洁，清晰
2.2.2.函数说明
为大多数函数编写函数说明。
说明中应包含以下内容：
/**********************************************
*name——函数名
*function——函数功能
*input——输入参数
*output——输出参数
*returnvalue——返回值
*author——作者
**********************************************/
2.2.3.条件执行语句if…else
a）尽量减少对非条件的测试，即语句块仅当条件为真的情况下才被执行
b）嵌套层不超过5层
c）当嵌套层太深时，可采用case语句
2.2.4.重复执行while和跳转语句goto
尽量减少goto语句的应用。
2.2.5.书写格式
2.2.6.字体
a）系统保留字用大写，用户自定义部分使用小写
b）注释行的首字母使用大写，对变量、某条件字句的注释可全部使用小写
2.2.7.数据对象的国际化
3.软件开发规范的控制
升级会员 