软件功能规格说明书编写规范
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
软件功能规格说明书
编写规范
目录
1. 目的
2. 适用范围
3. 术语及缩略语
4. 编写规范
4.1排版规范
4.2模板使用
5. 引用文件
5.1NW503101《需求分析报告编写规范》
6. 附录
1.目的
本文件是为了指导开发人员编写软件功能规格说明书。
2.适用范围
适用于本公司软件项目的软件功能规格说明书的编写。
3.术语及缩略语
本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。
4.编写规范
4.1排版规范
1)整个规范由2节构成,模板单独一节。
2)正文样式采用“规范正文”。
3)标题编号采用每节独立编号。
4.2模板使用
1)拷贝规范。
2)删除第一节(软件功能规格说明书封面前的所有页)。
3)在修改完内容后,更新目录域和相关的页数域。
5.引用文件
5.1 NW503101《需求分析报告编写规范》
6.附录
以下部分为软件功能规格说明书的模板。
密级:机密
文档编号:第版分册名称:XX系统(或子系统)功能规格说明书
修改记录编号:第册/共册
项目名称(项目编号)
需求分析报告
(部门名称)
目录
1. 引言 (3)
1.1目标 (3)
1.2用户的特点 (3)
2. 假定和约束 (3)
3. 功能规定 (3)
3.1功能分解表 (3)
3.2数据描述表 (4)
3.3对性能等其他专门要求 (4)
4. 运行环境规定 (4)
5. 程序接口 (4)
6. 程序运行方式 (4)
7. 开发成本和进度估算 (4)
8. 尚需解决的问题 (4)
9. 附录 (5)
1.引言
1.1目标
说明子系统的定义等。
1.2用户的特点
列出本功能的最终用户的应用水平属需求分析报告中的哪一类。此外,本功能用户还有一些什么其它特点,如用户会使用SQL语言等。
1.3术语
列出本报告中用到的专门术语的定义。
2.假定和约束
列出进行本功能开发工作所需的一些假定条件和必须满足的约束,例如本功能开发假定用户会熟练使用SQL语言,本功能应在某功能实现前开发完成等。
3.功能规定
3.1功能分解表
本节以表的形式按被管理的用户数据列出所有子功能。编写格式见附录的《软件功能规格表》。
软件功能规格表填表说明:
1)序号:由项目软件经理PSM根据本系统各功能分解关系统一编号;
2)数据序号:子功能使用的软件数据表中数据的序号;
3)制表:填写编写本表责任人的名字;
4)审核:由项目软件经理PSM签字;
5)日期:填报日期;
6)处理方法名:如财务系统的记帐、帐簿打印等;
7)类型:
类型分为共享或私有,如果该处理方法仅针对本类型数据,则它是私有的,如果该处理方法还适用于其它类型数据则为共享的;
8)处理说明(对应两行);
9)第一行用于简单说明该处理方法的内容;
10)第二行列出本方法有关的资料参考如算法详细描述书籍、相关的业务流程规范等。
3.2数据描述表
如果子系统有单独的数据或数据库表等,需在表中描述。每个数据或表单独填写一页。
如果有相同作用的文档,可以填写参考说明如存档编号、名称等。编写格式见附录的《软件数据规格表》。
软件数据规格表填表说明:
1)序号:由项目软件经理PSM根据本系统分解关系统一编号;
2)制表:填写编写本表责任人的名字;
3)审核:由项目软件经理PSM签字;
4)日期:填报日期;
5)数据说明:说明数据的作用等概述性信息;
6)数据项说明:说明数据项的名称、取值范围、类型、作用等。
3.3对性能等其他专门要求
本处仅列出不同于需求分析报告中的对性能等方面的特殊要求。
4.运行环境规定
在此说明本软件功能所需的运行环境,本处只列该功能运行环境与需求分析报告不同或没有的部分。即使用哪些特殊技术,需要哪些特殊的支撑软件等。
5.程序接口
说明该功能与本系统中其它功能及与非本系统的其他软件之间的公共接口、数据通信协议等。
6.程序运行方式
说明该功能软件的运行方法。如是部件、还是独立运行程序、API等。
7.开发成本和进度估算
对开发人时和费用(中差旅费)给出基本估算。
8.尚需解决的问题
以列表的形式列出在需求分析阶段必须解决但尚未解决的问题。
9.附录
软件功能规格表
软件数据规格表