软件开发需求说明书模板

更新时间:2024-05-14 18:48:01 阅读量: 综合文库 文档下载

说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。

需求说明书〈Vm.n〉 XX软件需求说明书

技术文件名称:软件需求说明书 技术文件编号:<小四Arial及宋体> 版 本:<小四Arial及宋体 Vm.n >

共 [单击键入总页数] 页

(包括封面)

拟 制 [单击此处键入作者] 审 核 [单击此处键入审核者] 会 签 [单击此处键入会签者1] [单击此处键入会签者2] [单击此处键入会签者3] [单击此处键入会签者4] 标准化 [单击此处键入标准化者] 批 准 [单击此处键入批准者]

1

需求说明书〈Vm.n〉

【模板使用说明:

(1) 模板内容供参考,可以根据实际情况删除或增加二级和三级标题要求的内容,

但不能删除一级标题。

(2) 对于模板中涉及数据的分析和统计,建议使用表格和图形表示,使数据更清晰

直观。

(3) 模板中有关流程图的绘制请使用VISIO。 (4) 本文档编制请使用Microsoft Office2007。

(5) 表的编号写在表的上面并居中位置,根据章编号,例:表1.1(第1章中的第1

个表格)。表格转页时应有表头。表的编号和名称用五号黑体。表的编号需在正文中提到。

(6) 图的编号写在图的下方并居中位置,根据章编号,例:图3.4(第3章中的第4

个图)。图的编号和名称用五号黑体,图的编号需在正文中提到。

(7) 术语中文名称、英文对应词均用五号黑体,中间空一个字,英文首字母大写,

其它用小写,定义用五号宋体。英文缩略语或其它特殊格式请咨询标准化人员。

(8) 在编辑完整个文档后,点击鼠标右键,选择“更新域——更新整个目录”即可。 (9) 请在完成整个文档的编写后,将模板中给出的说明删除,正式发布前应当接受

对文档所做的全部修订。】

2

需求说明书〈Vm.n〉

修改记录

文件编号 < 版本号 Vm.n 拟制人/ 修改人 XXX 拟制/修改日期 更改理由 XXXX> 主要更改内容 (写要点即可) 2015/05/06 XXX 注1:每次更改归档文件(指归档到中研院或公司档案室的文件)时,需填写此表。 注2:文件第一次归档时,“更改理由”、“主要更改内容”栏写“无”。

3

需求说明书〈Vm.n〉

目 录

1

引言 .................................................................................................................................................. 1 1.1 1.2 1.3 2

编写目的 ................................................................................................................................. 1 预期的读者和阅读建议.......................................................................................................... 1 文档约定 ................................................................................................................................. 1

术语、定义和缩略语 ...................................................................................................................... 1 2.1 2.2

术语、定义 ............................................................................................................................. 1 缩略语 ..................................................................................................................................... 2

3 综合描述 .......................................................................................................................................... 2 3.1 3.2 3.3

背景 ......................................................................................................................................... 2 软件概述 ................................................................................................................................. 3 运行环境 ................................................................................................................................. 3

4 具体需求 .......................................................................................................................................... 1 4.1

功能需求 ................................................................................................................................. 1

4.1.1.1 4.1.1.2

<需求组1标识-01 + 两个空格 + 需求组1的第1条子需求名称> ................................... 3 <需求组1标识-02 + 两个空格 + 需求组1的第2条子需求名称> ................................... 6

4.1.1 <需求组1标识 + 两个空格 + 需求组1名称> ........................................................... 3

4.1.2 <需求编号2 + 两个空格 + 需求名称2(IPO例)> .................................................. 6 4.2 4.3 4.4

外部接口需求 ......................................................................................................................... 7 性能需求 ................................................................................................................................. 7 质量属性需求 ......................................................................................................................... 8

可靠性 ........................................................................................................................... 10 4.4.2 安全性 ........................................................................................................................... 11 4.4.3 可维护性 ....................................................................................................................... 11 4.4.4 可移植性 ....................................................................................................................... 11 4.4.5 扩展性 ........................................................................................................................... 12 4.4.6 可测试性 ....................................................................................................................... 12 4.5 其它需求 ............................................................................................................................... 13 4.5.1 通用化、系列化、模块化需求 ................................................................................... 13 4.5.2 设计和实现上的限制 ................................................................................................... 14 4.5.3 执行标准 ....................................................................................................................... 15 4.5.4 国际化需求 ................................................................................................................... 15 4.5.5 杂类需求 ....................................................................................................................... 16

5

参考文献 ........................................................................................................................................ 16

4.4.1

4

需求说明书〈Vm.n〉

1 引言

1.1 编写目的

本文通过详细描述< XX>的功能需求、性能需求、质量属性需求、外部接口需求以及其它需求,为后续设计、实现、测试、用户文档等工作提供基础与约束。

1.2 预期的读者和阅读建议

预期的读者和阅读建议参见表1.1。

表1.1 读者分类 <项目经理 设计与开发工程师 售前、售后工程师/用户代表 测试工程师 文档工程师 阅读重点 全文,并据此编制/修订项目(软件)开发计划等。 需求的完整性、正确性、可行性、优先级、无二义性,为概要设计作准备。 需求的必要性、优先级,并据此准备市场资料。 需求的可验证性,并据此准备(软件)系统测试方案。 全文,为编写用户文档作准备。 备注 > 1.3 文档约定

<本节描述编写文档时所采用的排版约定(如正文风格、重要符号),说明需求优先级的取值及其含义等。应将每一类内容用一段或若干段进行描述,即应避免在一段中描述所有这些内容。>

2 术语、定义和缩略语

<本节描述本文使用到的术语、定义和缩略语。

应尽可能早地在项目的早期就开始编写独立的、产品/项目通用的术语、定义与缩略语,其它文档直接引用该文档中的内容(而不是重新定义),以保持理解的正确性与一致性,避免冗余和误解。对于那些专用的术语、定义和缩略语,则应放在使用这些内容的文档中描述。>

2.1 术语、定义

本文使用的专用术语、定义见表2.1,通用术语、定义见<文件编号> 《术语、定义和缩略语》。

表2.1

术语/定义 英文对应词 含 义 指“被描述系统(SuD ,System Under Description)“做什么”(功能需求)及“做什么”时的水平(非功能需求,如性能需求、质量属性需求、外部接口需求、其它需求)。这个通俗定义是针对技术需求的,而非技术需求(如进度的限制)一般不在本文档中给出(一般放在研制任务书/项目计划中)。 > <需求 requirement 1

需求说明书〈Vm.n〉

2.2 缩略语

本文使用的专用缩略语见表2.2,通用缩略语见<文件编号> 《术语、定义和缩略语》。缩略语已按其第1个字母顺序排列。<注意:缩略语应按其第一个字母顺序排列>

表2.2

缩略语 中文含义 3 综合描述

3.1 背景

<说明:一般说来,SRS中应有项目范围的描述,而项目范围一般通过项目视图来体现。我司不管哪种类型的项目,总要首先编写《研制任务书》,将项目视图、范围写在《研制任务书》中是最合适的。因此,SRS中不反映这部分内容。>

<本节主要描述以下内容:

a) 项目的背景和起源。对于在老版本之上升级的系统,则还应说明:

1) 老版本出现的主要问题;

2) 新版本需要增加或改进的主要内容。

此段内容可能来自于可行性研究报告等上游相关文档。应该对相关内容进行概括而不是照抄。

b) 本产品在整个系统或整个环境中的位置。应使用上下文图(context diagram) 或其

它形式的图说明本产品(必须用文字及不同的颜色明确标识出来)与外界(可能包括整个系统外的实体)之间的联系,如图3.1。图形应能清晰地表达产品与外部环境的边界,及产品与外部环境的关系,以帮助读者更好、更快地理解被描述的系统。实践中经常犯的错误是 1) 不画图;

2) 画了产品内部组成图、协议栈或软件结构图(关于最后一点,正确的做法是:

应将软件结构图以SuD为中心,转化为上下文图,即去掉各个外部系统之间的联系,当然,各个外部系统与SuD的联系还得保留); 2) 在上下文图中,还描述了外部系统之间关系。

2

需求说明书〈Vm.n〉

2.2 缩略语

本文使用的专用缩略语见表2.2,通用缩略语见<文件编号> 《术语、定义和缩略语》。缩略语已按其第1个字母顺序排列。<注意:缩略语应按其第一个字母顺序排列>

表2.2

缩略语 中文含义 3 综合描述

3.1 背景

<说明:一般说来,SRS中应有项目范围的描述,而项目范围一般通过项目视图来体现。我司不管哪种类型的项目,总要首先编写《研制任务书》,将项目视图、范围写在《研制任务书》中是最合适的。因此,SRS中不反映这部分内容。>

<本节主要描述以下内容:

a) 项目的背景和起源。对于在老版本之上升级的系统,则还应说明:

1) 老版本出现的主要问题;

2) 新版本需要增加或改进的主要内容。

此段内容可能来自于可行性研究报告等上游相关文档。应该对相关内容进行概括而不是照抄。

b) 本产品在整个系统或整个环境中的位置。应使用上下文图(context diagram) 或其

它形式的图说明本产品(必须用文字及不同的颜色明确标识出来)与外界(可能包括整个系统外的实体)之间的联系,如图3.1。图形应能清晰地表达产品与外部环境的边界,及产品与外部环境的关系,以帮助读者更好、更快地理解被描述的系统。实践中经常犯的错误是 1) 不画图;

2) 画了产品内部组成图、协议栈或软件结构图(关于最后一点,正确的做法是:

应将软件结构图以SuD为中心,转化为上下文图,即去掉各个外部系统之间的联系,当然,各个外部系统与SuD的联系还得保留); 2) 在上下文图中,还描述了外部系统之间关系。

2

本文来源:https://www.bwwdw.com/article/wiz7.html

Top