软件工程文档模板范例.docx

软件工程文档模板范例.docx

《软件工程文档模板范例.docx》由会员分享，可在线阅读，更多相关《软件工程文档模板范例.docx（27页珍藏版）》请在冰豆网上搜索。

软件工程文档模板范例

3　软件需求说明书

　　软件需求说明书的编制是为了使用户的软件开发者双方对该软件的起初规定有一个共同的理解，使之成为整个开发工作的基础。

编制软件需求说明书的容要求如下：

　　3.1　引言

　　3.1.1　编写的目的

　　3.1.2　背景

　　3.1.3　定义

　　3.1.1　参考资料

　　3.2　任务概述

　　3.2.1　目标

　　3.2.2　用户的点

　　3.2.3　假定与约束

　　3.3　需求规定

　　3.3.1　对功能的规定

　　3.3.2　对性能的规定

　　3.3.2.1　精度

　　3.3.2.2　时间特性要求

　　3.3.2.3　灵活性

　　3.3.3　输入输出要求

　　3.3.4　数据管理能力的要求

　　3.3.5　故障处理要求

　　3.3.6　其它的专门的要求

　　3.4　运行环境规定

　　3.4.1　设备

　　3.4.2　支持软件

　　3.4.3　接口

　　3.4.4　控制

4　数据需求说明书

　　数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。

编制数据要求说明书的容要求如下：

　　4.1　引言

　　4.1.1　编写目的

　　4.1.2　背景

　　4.1.3　定义

　　4.1.4　参考资料

　　4.2　数据的逻辑描述

　　4.2.1　静态数据

　　4.2.2　动态输入数据

　　4.2.3　动态输出数据

　　4.2.4　部生成数据

　　4.2.5　数据约定

　　4.3　数据的采集

　　4.3.1　要求和围

　　4.3.2　输入的承担者

　　4.3.3　处理

　　4.3.4　影响

5　概要设计说明书

　　概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。

编制概要设计说明书的容要求如下：

　　5.1　引言

　　5.1.1　编写目的

　　5.1.2　背景

　　5.1.3　定义

　　5.1.4　参考资料

　　5.2　总体设计

　　5.2.1　需求规定

　　5.2.2　运行环境

　　5.2.3　基本设计概念和处理流程

　　5.2.4　结构

　　5.2.5　功能需求与程序的关系

　　5.2.6　人工处理过程

　　5.2.7　尚未解决的问题

　　5.3　接口设计

　　5.3.1　用户接口

　　5.3.2　部接口

　　5.3.3　外部接口

　　5.4　运行设计

　　5.4.1　运行模块组合

　　5.4.2　运行控制

　　5.4.3　运行时间

　　5.5　系统数据结构设计

　　5.5.1　逻辑结构设计要点

　　5.5.2　物理结构设计要点

　　5.5.3　数据结构与程序的关系

　　5.6　系统出错处理设计

　　5.6.1　出错信息

　　5.6.2　补救措施

　　5.6.3　系统维护设计

6　详细设计说明书

　　详细说明书可称作程序设计说明书。

编制目的是说明一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关容合并概要设计说明书。

对详细设计说明书的容要不得要求如下：

　　6.1　引言

　　6.1.1编写目的

　　6.1.2背景

　　6.1.3定义

　　6.1.4参考资料

　　6.2程序系统的组织结构

　　6.3程序1（标识符）设计说明

　　6.3.1程序描述

　　6.3.2功能

　　6.3.3性能

　　6.3.4输入项

　　6.3.5输出项

　　6.3.6算法

　　6.3.7流程逻辑

　　6.3.8接口

　　6.3.9存储分配

　　6.3.10注释设计

　　6.3.11限制条件

　　6.3.12测试计划

　　6.3.13尚未解决的问题

　　6.4程序2（标识符）设计说明

　　……

三、需求规格说明书

1．引言

1.1编写目的

      为明确软件需求、安排项目规划与进度、组织软件开发与测试，撰写本文档。

      本文档供项目经理、设计人员、开发人员参考。

1.2项目背景

a.      项目的委托单位、开发单位和主管部门

b.      该软件系统与其他

1.3定义

【列出文当中所用到的专门术语的定义和缩写词的原文。

】

1.4参考资料

a.      项目经核准的计划任务书、合同或上级机关的批文

b.      项目开发计划

c.      文档所引用的资料、标准和规。

列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源

2．任务概述

2.1目标

2.2运行环境

操作系统：

MicrosoftWindows2000AdvancedServer

支持环境：

IIS5.0

数据库：

MicrosoftSQLServer2000

2.3条件与限制

3．数据描述

3.1静态数据

3.2动态数据

【包括输入数据和输出数据。

】

3.3数据库介绍

【给出使用数据库的名称和类型。

】

3.4数据词典

3.5数据采集

4．功能需求

4.1功能划分

4.2功能描述

5．性能需求

5.1数据精确度

5.2时间特性

【如响应时间、更新处理时间、数据转换与传输时间、运行时间等。

】

5.3适应性

【在操作方式、运行环境、与其它软件的接口以及开发计划等发生变化时，应具有的适应能力。

】

6．运行需求

6.1用户界面

【如屏幕格式、报表格式、菜单格式、输入输出时间等。

】

6.2硬件接口

6.3软件接口

6.4故障处理

7．其它需求

【如可使用性、安全、可维护性、可移植性等。

】

四、概要设计说明书

1．引言

1.1编写目的

【阐明编写概要设计说明书的目的，指明读者对象。

】

1.2项目背景

【应包括：

a.      项目的委托单位、开发单位和主管部门；

b.      该软件系统与其他系统的关系。

】

1.3定义

【列出本文档中所用到的专门术语的定义和缩写词的原文。

】

1.4参考资料

【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：

a.      项目经核准的计划任务书、合同或上级机关的批文；

b.      项目开发计划；

c.      需求规格说明书；

d.      测试计划（初稿）；

e.      用户操作手册（初稿）；

f.       文档所引用的资料、采用的标准或规。

】

2．任务概述

2.1目标

2.2运行环境

2.3需求概述

2.4条件与限制

3．总体设计

3.1处理流程

3.2总体结构和模块外部设计

3.3功能分配

【表明各项功能与程序结构的关系。

】

4．接口设计

4.1外部接口

【包括用户界面、软件接口与硬件接口。

】

4.2部接口

【模块之间的接口。

】

5．数据结构设计

5.1逻辑结构设计

5.2物理结构设计

5.3数据结构与程序的关系

6．运行设计

6.1运行模块的组合

6.2运行控制

6.3运行时间

7．出错处理设计

7.1出错输出信息

7.2出错处理对策

【如设置后备、性能降级、恢复及再启动等。

】

8.安全设计

9.维护设计

【说明为方便维护工作的设施，如维护模块等。

】

五、详细设计说明书

1．引言

1.1编写目的

【阐明编写详细设计说明书的目的，指明读者对象。

】

1.2项目背景

【应包括项目的来源和主管部门等。

】

1.3定义

【列出文档中所用到的专门术语的定义和缩写词的原文。

】

1.4参考资料

【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：

a. 项目的计划任务书、合同或批文；

b. 项目开发计划；

c. 需求规格说明书；

d. 概要设计说明书；

e. 测试计划（初稿）；

f. 用户操作手册（初稿）；

g. 文档中所引用的其他资料、软件开发标准或规。

】

2．总体设计

2.1需求概述

2.2软件结构

【如给出软件系统的结构图。

】

3．程序描述

【逐个模块给出以下的说明：

】

3.1功能

3.2性能

3.3输入项目

3.4输出项目

3.5算法

【模块所选用的算法。

】

3.6程序逻辑

【详细描述模块实现的算法，可采用：

a. 标准流程图；

b. PDL语言；

c. N－S图；

d. PAD；

e. 判定表等描述算法的图表。

】

3.7接口

3.8存储分配

3.9限制条件

3.10测试要点

【给出测试模块的主要测试要求。

】

六、用户操作手册

1．引言

1.1编写目的

【阐明编写手册的目的，指明读者对象。

】

1.2项目背景

【应包括项目的来源、委托单位、开发单位和主管部门。

】

1.3定义

【列出手册中所用到的专门术语的定义和缩写词的原文。

】

1.4参考资料

【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：

a. 项目的计划任务书、合同或批文；

b. 项目开发计划；

c. 需求规格说明书；

d. 概要设计说明书；

e. 详细设计说明书；

f. 测试计划；

g. 手册中引用的其他资料、采用的软件工程标准或软件工程规。

】

2．软件概述

2.1目标

2.2功能

2.3性能

a.      数据精确度【包括输入、输出及处理数据的精度。

】

b.      时间特性【如响应时间、处理时间、数据传输时间等。

】

c.      灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。

】

3．运行环境

3.1硬件

【列出软件系统运行时所需的硬件最小配置，如

a.      计算机型号、主存容量；

b.      外存储器、媒体、记录格式、设备型号及数量；

c.      输入、输出设备；

d.      数据传输设备及数据转换设备的型号及数量。

】

3.2支持软件

【如：

a.      操作系统名称及版本号；

b.      语言编译系统或汇编系统的名称及版本号；

c.      数据库管理系统的名称及版本号；

d. 其他必要的支持软件。

】

4.使用说明

4.1安装和初始化

【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。

】

4.2输入

【给出输入数据或参数的要求。

】

4.2.1数据背景

【说明数据来源、存储媒体、出现频度、限制和质量管理等。

】

4.2.2数据格式

【如：

a. 长度；

b. 格式基准；

c. 标号；

d. 顺序；

e. 分隔符；

f. 词汇表；

g. 省略和重复；

h. 控制。

】

4.2.3输入举例

4.3输出

【给出每项输出数据的说明。

】

4.3.1数据背景

【说明输出数据的去向、使用频度、存放媒体及质量管理等。

】

4.3.2数据格式

【详细阐明每一输出数据的格式，如：

首部、主体和尾部的具体形式。

】

4.3.3举例

4.4出错和恢复

【给出：

a. 出错信息及其含意；

b. 用户应采取的措施，如修改、恢复、再启动。

】

4.5求助查询

【说明如何操作。

】

5.运行说明

5.1运行表

【列出每种可能的运行情况，说明其运行目的。

】

5.2运行步骤

【按顺序说明每种运行的步骤，应包括：

】

5.2.1运行控制

5.2.2操作信息

a. 运行目的；

b. 操作要求；

c. 启动方法；

d. 预计运行时间；

e. 操作命令格式及说明；

f. 其他事项。

5.2.3输入/输出文件

【给出建立或更新文件的有关信息，如：

】

a. 文件的名称及编号；

b. 记录媒体；

c. 存留的目录；

d. 文件的支配【说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及控制等。

】

5.2.4启动或恢复过程

6.非常规过程

【提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。

】

7.操作命令一览表

【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

】

8.程序文件（或命令文件）和数据文件一览表

【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

】

9.用户操作举例

软件需求规格说明书样例

1.引言

1.1　编写目的:

编写此文档的目的是进一步定制软件开发的细节问题,便于用户与开发商协调工作.本文档面向的读者主要是项目委托单位的管理人员.希望能使本软件开发工作更具体.

1.2　项目背景

1.2.1项目委托单位:

****公司

1.2.2开发单位:

***公司

1.3　定义

1.4　　参考资料

2.任务概述

2.1　目标:

<1>决策支持:

根据公司的要求及时提供所需报表及文件,并在适当时候对各部门领导给予销售及进货等方面的提示

<2>提高效率:

利用软件进行管理,避免人工管理的失误以及延迟性,从而实现高效率的管理.

2.2　运行环境:

<1>硬件方面:

Pentium级处理芯片

　　1兆显存的兼容显卡

　　256色,800*600的兼容显示器

　　标准兼容打印机

<2>软件方面:

WIN95操作系统

2.3　条件与限制:

　　编程用计算机一台

　　完成期限2000/7/1

　　无资金供给

3.数据概述

数据流程图如下:

3.1　静态数据:

包括系统登录密码,各数据库所在位置,系统分析原始数据

3.2　动态数据:

包括各数据库各项显示数据,用户登录信息,系统时间

3.3　数据库描述:

　　人事管理数据库:

公司人员的个人详细信息,包括档案信息

　　销售管理数据库:

当日销售记录及以前的销售统计,用于销售分析

　　财务管理数据库:

公司部账目及收支情况详表

　　技术管理数据库:

公司所需各技术档案的详细记录（包括文档）

3.4数据字典:

<1>数据流词条描述:

　　1.数据流名:

登录信息

　　来源:

用户的输入

　　去向:

系统部检验部分

　　组成:

用户名,密码

　　流通量:

每次登录输入一次

　　2.数据流名:

登录结果

　　来源:

系统

　　去向:

用户

　　组成:

返回信息

　　流通量:

每次登录返回一次

　　3.数据流名:

输入修改信息

　　来源:

用户

　　去向:

系统判断部分

　　组成:

根据各数据库容而不同

　　流通量:

依用户输入而定

　　4.数据流名:

反馈信息

　　来源:

系统判断部分

　　去向:

用户

　　组成:

系统经判断后发回的字符数据

　　流通量:

依系统当前信息而定

　　5.数据流名:

识别信息

　　来源:

系统部检验部分

　　去向:

系统判断部分

　　组成:

系统各数据库的标识信息

　　流通量:

用户每次输入流通一次

　　6.数据流名:

处理信息

　　来源:

系统判断部分

　　去向:

各数据库处理部分

　　组成:

读取/修改标识,读取/修改的变量名称

　　流通量:

用户每次输入流通一次

　　7.数据流名:

读取修改

　　来源:

系统判断部分

　　去向:

系统各数据库

　　组成:

读取/修改标识,读取/修改容

　　流通量:

用户每次输入流通一次

<2>数据文件词条描述:

　　1.数据文件名:

人事数据

　　简述:

存储人员信息

　　数据文件组成:

人员的各项信息（以CString类型为主）

　　2.数据文件名:

销售数据

　　简述:

存储当日及从前的销售记录

　　数据文件组成:

销售的各项信息

　　3.数据文件名:

财务数据

　　简述:

存储财务管理信息

　　数据文件组成:

财务管理的各项记录

　　4.数据文件名:

技术数据

　　简述:

存储公司部使用的技术档案信息

　　数据文件组成:

技术档案名称,容

<3>加工逻辑词条描述:

　　1.加工名:

检验

　　简要描述:

判断用户的许可性

　　输入数据流:

登录信息

　　输出数据流:

登录结果

　　加工逻辑:

判断是否与系统部用户信息相符合

　　2.加工名:

判断

　　简要描述:

判断用户的操作并进行相应的读取/存储工作

　　输入数据流:

输入修改信息

　　输出数据流:

反馈信息

　　加工逻辑:

判断用户的操作->调用数据库->读取/修改->反馈

　　3.加工名:

人事档案管理

　　简要描述:

对人事数据库进行相应要求的操作,并与判断部分交互

　　输入数据流:

处理信息,读取修改

　　输出数据流:

读取修改,处理信息

　　加工逻辑:

判断用户要读取/修改的容->反馈用户所需信息

　　4.加工名:

销售统计

　　简要描述:

对销售数据库进行相应要求的操作,并与判断部分交互

　　输入数据流:

处理信息,读取修改

　　输出数据流:

读取修改,处理信息

　　加工逻辑:

判断用户要读取/修改的容->反馈用户所需信息

　　5.加工名:

财务统计

　　简要描述:

对财务数据库进行相应要求的操作,并与判断部分交互

　　输入数据流:

处理信息,读取修改

　　输出数据流:

读取修改,处理信息

　　加工逻辑:

判断用户要读取/修改的容->反馈用户所需信息

　　6.加工名:

技术管理

　　简要描述:

对技术统计数据库进行相应要求的操作,并与判断部分交互信息

　　输入数据流:

处理信息,读取修改

　　输出数据流:

读取修改,处理信息

　　加工逻辑:

判断用户要读取/修改的容->反馈用户所需信息

<4>源点及汇点词条描述:

　　名称:

用户

　　简要描述:

既是源点又是汇点,发出动作信息给"检验"和"判断"加工,通过交互界面接受反馈信息有关数据流:

登录结果,登录信息,输入修改信息,反馈信息

　　数目:

一个

4.功能需求

4.1　功能划分

　　可细分为四部分:

人事管理,销售管理,财务管理,技术档案管理

4.2　功能描述

<1>人事功能:

（1）能对公司部的所有人员有关档案详细资料记录并保存。

（2）能对数据库人事档案的数据进行查阅和修改。

　　（3）能按部门或检索人员。

　　（4）当某员工的雇用期限达到整年时，按时提醒。

<2>销售统计功能

（1）按日对公司的销售情况进行统计,包括销售额\销售数量\各地区销售比例\不同销售方式的销售量比例以及销售毛利润情况

（2）制定销售情况的月报表\季报表以及年报表对销售情况进行分析,对不同销售人员的业绩进行评定

<3>财务管理功能

（1）协助财务人员进行计算机管理,对库存情况\进货情况\销货进行登录和输出

（2）根据预设的库存情况提醒进货

　　（3）对收款情况进行统计,在应收帐款达到预设值时进行提示

<4>技术管理功能

（1）对技术资料进行登录

（2）对维修记录进行登录和统计,按不同型号的机器进行故障整体分析,并作出分析报告

　　（3）对维修配件的需求进行管理并及时提示备货

5.性能需求

5.1　数据精确度:

因为此数据为公司部数据,所以要求不能有误差

5.2　时间特性:

当日销售统计要求有即时性,马上能反应出存货的问题;同时财务管理数据计算当前存货情况,并对进货情况进行估算

5.3　适应性:

此软件只在公司部管理人员的机器上使用,因此不考虑适应性

6.运行需求

6.1　用户界面:

　　屏幕格式:

（1）要求有菜单及工具栏以方便操作

（2）各数据库信息可在屏幕上直接修改

　　（3）各数据统计结果可在屏幕上显示

　　（4）进行系统分析后的结果在另一窗口中显示

　　报表格式:

（1）人事管理报表只要求有个人的普通数据

（2）销售统计报表要求可分别打印当日统计或之前的统计

　　（3）财务统计报表要求打印出存货及公司帐务详表

　　（4）技术管理报表要求可以分别打印技术档案总表和任一技术档案文档容菜单格式:

要求菜单项大致与WIN95标准相同,另外附加的功能做到新的单项中输入输出时间:

年份以4位数字表示

6.2　硬件接口:

需要标准打印机接口进行报表打印

6.3　软件接口:

Windows标准接口

7.其他需求

　　可使用性:

要求容易使用,界面友好

　　安全性:

因本数据属于公司部管理用关键数据,因此除公司管理人员外,其他人员不得访问.要求设有登录密码检验功能,并且此密码可以在以后进行修改

　　可维护性:

要求本软件的维护文档齐全,便于维护

软件需求规格说明书模板   

  修订历史   

  版本说明编制批准批准日期   

  1.1初次编写SEPG   

  目　录   

  1.引言1   

  1.1.背景1   

  1.2.参考资料1   

  1.3.假定和约束1   

  1.4.用户的特点1   

  2.功能需求1   

  2.1.系统围1   

  2.2.系统体系结构（二层架构的系统可剪裁本小节）1   

  2.3.系统总体流程2   

  2.4.需求分析2   

  2.4.1.XXXXXXX（功能需求名称）2   

  2.4.1.1.功能描述2   

  2.4.1.2.业务建模2   

  2.4.1.3.用例描述3   

  2.4.1.4.用户界面5   

  2.4.2.XXXXXXX（功能需求名称）5   

  3.非功能需求5   

  3.1.性能要求5   

  3.1.1.精度5   

  3.1.2.时间特性要求6   

  3.1.3.输人输出要求6   

  3.2.数据管理能力要求6   

  3.3.安全性要求6   

  3.4.灵活性要求6   

  3.5.其他专门要求6   

  4.运行环境规定6   

  4.1.设备6   

  4.2.支持软件7   

  4.3.接口7   

  4.4.控制7   

  5.需求跟踪7   

  6.签批单7   

  1.引言   

  1.1.背景   

  说明：

  a．待开发的软件系统的名称；   

  b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；   

  C．该软件系统同其他系统或其他机构的基本的相互来往关系。

  1.2.参考资料     

  列出本说明书中引用和参考的资料，如：

  a．本项目的经核准的计划任务书或合同、上级机关的批文；   

  b．属于本项目的其他已发表的文件；   

  c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。

   列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

  1.3.假定和约束[可选]   

  列出进行本软件开发工作的假定和约束，例如经费限制、开发期限、设备条件、用户的资料准备和交流上的问题等。

  1.4.用户的特点[可选]   

  列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术