软件工程指导书编写模板.docx
- 文档编号:8970287
- 上传时间:2023-02-02
- 格式:DOCX
- 页数:42
- 大小:68.58KB
软件工程指导书编写模板.docx
《软件工程指导书编写模板.docx》由会员分享,可在线阅读,更多相关《软件工程指导书编写模板.docx(42页珍藏版)》请在冰豆网上搜索。
软件工程指导书编写模板
一、可行性研究报告
1.引言
1.1编写目的
【阐明编写可行性研究报告的目的,指明读者对象。
】
1.2项目背景
【应包括:
a.所建议开发软件的名称;
b.项目的任务提出者、开发者、用户及实现软件的单位;
c.项目与其他软件或其他系统的关系。
】
1.3定义
【列出文档中所用到的专门术语的定义和缩写词的原文。
】
1.4参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
a.项目经核准的计划任务书、合同或上级机关的批文;
b.与项目有关的已发表的资料;
c.文档中所引用的资料,所采用的软件标准或规范。
】
2.可行性研究的前提
2.1要求
【列出并说明建议开发软件的基本要求,如
a.功能;
b.性能;
c.输出;
d.输入;
e.基本的数据流程和处理流程;
f.安全与保密要求;
g.与软件相关的其他系统;
h.完成期限。
】
2.2目标
【可包括:
a.人力与设备费用的节省;
b.处理速度的提高;
c.控制精度或生产能力的提高;
d.管理信息服务的改进;
e.决策系统的改进;
f.人员工作效率的提高,等等。
】
2.3条件、假定和限制
【可包括:
a.建议开发软件运行的最短寿命;
b.进行系统方案选择比较的期限;
c.经费来源和使用限制;
d.法律和政策方面的限制;
e.硬件、软件、运行环境和开发环境的条件和限制;
f.可利用的信息和资源;
g.建议开发软件投入使用的最迟时间。
】
2.4可行性研究方法
2.5决定可行性的主要因素
3.对现有系统的分析
3.1处理流程和数据流程
3.2工作负荷
3.3费用支出
【如人力、设备、空间、支持性服务、材料等项开支。
】
3.4人员
【列出所需人员的专业技术类别和数量。
】
3.5设备
3.6局限性
【说明现有系统存在的问题以及为什么需要开发新的系统。
】
4.所建议技术可行性分析
4.1对系统的简要描述
4.2处理流程和数据流程
4.3与现有系统比较的优越性
4.4采用建议系统可能带来的影响
4.4.1对设备的影响
4.4.2对现有软件的影响
4.2.3对用户的影响
4.2.4对系统运行的影响
4.2.5对开发环境的影响
4.2.6对运行环境的影响
4.2.7对经费支出的影响
4.5技术可行性评价
【包括:
a.在限制条件下,功能目标是否能达到;
b.利用现有技术,功能目标能否达到;
c.对开发人员数量的和质量的要求,并说明能否满足;
d.在规定的期限内,开发能否完成。
】
5.所建议系统经济可行性分析
5.1支出
5.1.1基建投资
5.1.2其他一次性支出
5.1.3经常性支出
5.2效益
5.2.1一次性收益
5.2.2经常性收益
5.2.3不可定量收益
5.3收益/投资比
5.4投资回收周期
5.5敏感性分析
【敏感性分析是指一些关键性因素,如:
系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。
】
6.社会因素可行性分析
6.1法律因素
【如,合同责任、侵犯专利权、侵犯版权等问题的分析。
】
6.2用户使用可行性
【如,用户单位的行政管理、工作制度、人员素质等能否满足要求。
】
7.其他可供选择的方案
【逐个阐明其他可供选择的方案,并重点说明未被推荐的理由。
】
8.结论意见
【结论意见可能是:
a.可着手组织开发;
b.需待若干条件(如资金、人力、设备等)具备后才能开发;
c.需对开发目标进行某些修改;
d.不能进行或不必进行(如技术不成熟,经济上不合算等);
e.其他。
】
二、项目开发计划
1.引言
1.1编写目的
本报告的主要作用是确定各个项目模块的开发情况和主要的负责人,供各项目模块的负责人阅读,做到及时协调,按步有序进行项目的开发.减少开发中的不必要损失.
具体步骤:
拟订开发计划书,分配项目工作,安排项目进度。
计划对象:
开发小组成员,主要帮助控制开发进度。
1.2项目背景
因为软件是面对档案管理问题,用来提高档案管理的效率。
故建议软件名为《档案管理系统》。
项目提出者是A公司档案科,由于该公司已经拥有公司内网,档案众多,至今未知有15000多份。
故需要该系统进行档案的辅助管理。
开发者叶青龙。
用户为该公司具有相应权限的管理人员。
档案管理系统是机关、单位或公司管理系统的一个子系统,档案管理系统为其他系统提供员工档案的基本信息,与人事管理系统共享人事基本数据。
2.项目概述
2.1工作内容
各工作小组根据时间先后安排,分别对项目进行开发:
各项主要工作:
需求分析对A公司工作流程进行调研(为期三天)。
软件开发人员对调查结果进行分析,拟订实现方案(如程序结构,流程,数据结构等)。
软件编程人员对软件进行集中开发。
软件审核人员对软件进行评定,审核。
2.2条件与限制
完成项目应具备的条件:
●资金
●调研环境
●开发平台
●开发基础设施
●开发人员
●维护人员
开发单位已具有的条件:
●开发基础设施
●开发平台
尚须创造的条件:
●良好的调研环境
资方应提供足够的资金和开发条件,并详细的阐明要求。
工方应依据资方的要求开发出满足合同要求的工程。
2.3产品
2.3.1程序
3.1程序
程序名称:
使用语言:
C++
存储形式:
磁盘
3.2文档
许提交的文档:
●项目开发计划
●资金分配方案
●系统使用手册
●系统维护手册
●详细技术资料
2.4运行环境
运行硬件环境:
PII233PC以上,
运行软件环境:
SQLServer2000,WindowsNT,98以上
1.服务
开发单位向用户提供服务:
人员培训,系统安装,保修(一年),维护(五年)。
2.验收标准
系统运行流畅,出错率为:
2次/年。
3.实施计划
3.1任务分解
调研
设计
开发
测试
维护
3.2进度
【按阶段完成的项目,用图表说明开始时间、完成时间。
】
3.3预算
分析阶段
设计阶段
写代码及单元测试阶段
总测试及修改阶段
3.4关键问题
【说明可能影响项目的关键问题,如设备条件、技术焦点或其他风险因素,并说明对策。
】
4.人员组织及分工
调研小组:
设计小组:
开发小组:
测试小组:
维护小组:
5.交付期限
最迟交付日期:
。
6.专题计划要点
【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。
】
三、需求规格说明书
1.引言
1.1编写目的
需求分析说明书是为软件的开发者能更好的理解开发的需求,避免由于对问题认识的不清或错误理解而增加更多的开发成本。
需求分析是软件系统生存期中定义阶段的最后一个步骤。
是作为整个软件开发范围的指南,是软件开发人员开发出正确的符合用户要求的软件的重点。
是为明确软件需求、安排项目规划与进度、组织软件开发与测试,撰写本文档该文档将最终交给软件具体开发人员进行具体的开发,其针对的对象是软件开发人员。
1.2项目背景
d.项目的委托单位、开发单位和主管部门
e.该软件系统与其他
1.3定义
【列出文当中所用到的专门术语的定义和缩写词的原文。
】
1.4参考资料
d.项目经核准的计划任务书、合同或上级机关的批文
e.项目开发计划
f.文档所引用的资料、标准和规范。
列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源
2.任务概述
2.1目标
2.2运行环境
操作系统:
MicrosoftWindows2000AdvancedServer
支持环境:
IIS5.0
数据库:
MicrosoftSQLServer2000
2.3条件与限制
支持运行环境即可,在Windows下基本没限制。
3.数据描述
3.1静态数据
静态数据是系统内部有关的数据结构与操作规程。
档案记录信息表Archives_Content
档案分类资料信息表Archives_Class
档案柜资料信息表Archives_Tank
档案借用信息表Archives_Borrow
档案归还信息表Archives_Return
记录号计数数据表Archives_Count
安全管理信息表Archives_User
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项目背景
【应包括:
f.项目的委托单位、开发单位和主管部门;
g.该软件系统与其他系统的关系。
】
1.3定义
【列出本文档中所用到的专门术语的定义和缩写词的原文。
】
1.4参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
g.项目经核准的计划任务书、合同或上级机关的批文;
h.项目开发计划;
i.需求规格说明书;
j.测试计划(初稿);
k.用户操作手册(初稿);
l.文档所引用的资料、采用的标准或规范。
】
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参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
m.项目的计划任务书、合同或批文;
n.项目开发计划;
o.需求规格说明书;
p.概要设计说明书;
q.测试计划(初稿);
r.用户操作手册(初稿);
s.文档中所引用的其他资料、软件开发标准或规范。
】
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参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
t.项目的计划任务书、合同或批文;
u.项目开发计划;
v.需求规格说明书;
w.概要设计说明书;
x.详细设计说明书;
y.测试计划;
zz.手册中引用的其他资料、采用的软件工程标准或软件工程规范。
】
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.3定义
【列出测试计划中所用到的专门术语的定义和缩写词的原意。
】
1.4参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
aa.项目的计划任务书、合同或批文;
bb.项目开发计划;
cc.需求规格说明书;
dd.概要设计说明书;
ee.详细设计说明书;
ff.用户操作手册;
gg.本测试计划中引用的其他资料、采用的软件开发标准或规范。
】
2.任务概述
2.1目标
2.2运行环境
2.3需求概述
2.4条件与限制
3.计划
3.1测试方案
【说明确定测试方法和选取测试用例的原则。
】
3.2测试项目
【列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。
】
3.3测试准备
3.4测试机构及人员
【测试机构名称、负责人和职责。
】
4.测试项目说明
【按顺序逐个对测试项目做出说明:
】
4.1测试项目名称及测试内容
4.2测试用例
4.2.1输入
【输入的数据和输入命令。
】
4.2.2输出
【预期的输出数据。
】
4.2.3步骤及操作
4.2.4允许偏差
【给出实测结果与预期结果之间允许偏差的范围。
】
4.3进度
4.4条件
【给出测试对资源的特殊要求,如设备、软件、人员等。
】
4.5测试资料
【说明测试所需的资料。
】
5.评价
5.1范围
【说明所完成的各项测试说明问题的范围及其局限性。
】
5.2准则
【说明评价测试结果的准则。
】
八、测试分析报告
1.引言
1.1编写目的
【阐明编写测试分析报告的目的,指明读者对象。
】
1.2项目背景
【说明项目的来源、委托单位及主管部门。
】
1.3定义
【列出测试分析报告中所用到的专门术语的定义和缩写词的原文。
】
1.4参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
hh.项目的计划任务书、合同或批文;
ii.项目开发计划;
jj.需求规格说明书;
kk.概要设计说明书;
ll.详细设计说明书;
mm.用户操作手册;
nn.测试计划;
oo.测试分析报告所引用的其他资料、采用的软件工程标准或软件工作规范。
】
2.测试计划执行情况
2.1测试项目
【列出每一测试项目的名称、内容和目的。
】
2.2测试机构和人员
【给出测试机构名称、负责人和参与测试人员名单。
】
2.3测试结果
【按顺序给出每一测试项目的:
a.实测结果数据;
b.与预期结果数据的偏差;
c.该项测试表明的事实;
d.该项测试发现的问题。
】
3.软件需求测试结论
【按顺序给出每一项需求测试的结论。
包括:
a.证实的软件能力;
b.局限性(即项需求未得到充分测试的情况及原因)。
】
4.评价
4.1软件能力
【经过测试所表明的软件能力。
】
4.2缺陷和限制
【说明测试所揭露的软件缺陷和不足,以及可能给软件运行带来的影响。
】
4.3建议
【提出为弥补上述缺陷的建议。
】
4.4测试结论
【说明能否通过。
】
九、开发进度月报
1.报告时间及所处的开发阶段
2.工程进度
2.1本月内的主要活动
2.2实际进展与计划比较
3.所用工时
【按不同层次人员分别计时。
】
4.所用机时
【按所用计算机型分别计时。
】
5.经费支出
【分类列出本月经费支出项目,给出支出总额,并与计划比较。
】
6.工作遇到的问题及采取的对策
7.本月完成的成果
8.下月的工作计划
9.特殊问题
十、项目开发总结报告
1.引言
1.1编写目的
【阐明编写总结报告的目的,指明读者对象。
】
1.2项目背景
【说明项目来源、委托单位、开发单位及主管部门。
】
1.3定义
【列出报告用到的专门术语的定义和缩写词的原文。
】
1.4参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
pp.项目经核准的计划任务书、合同或上级机关的批文;
qq.项目开发计划;
rr.需求规格说明书;
ss.概要设计说明书;
tt.详细设计说明书;
uu.用户操作手册;
vv.测试计划;
ww.测试分析报告;
xx.本报告引用的其他资料、采用的开发标准或开发规范。
】
2.开发结果
2.1产品
【可包括:
a.列出各部分的程序名称、源程序行数(包括注释行)或目标程序字节数及程序总计数量、存储形式;
b.产品文档名称等。
】
2.2主要功能及性能
2.3所用工时
【按人员的不同层次分别计时。
】
2.4所用机时
【按所用计算机机型分别计时。
】
2.5进度
【给出计划进度与实际进度的对比。
】
2.6费用
3.评价
3.1生产率评价
【如平均每人每月生产的源程序行数、文档的字数等。
】
3.2技术方案评价
3.3产品质量评价
4.经验与教训
十一、程序维护手册
1.引言
1.1编写目的
【阐明编写手册的目的,指明读者对象。
】
1.2开发单位
【说明项目的提出者、开发者、用户和使用场所。
】
1.3定义
【列出报告中所用到的专门术语的定义和缩写词的原文。
】
1.4参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,以及保密级别,可包括:
yy.用户操作手册;
zzz.与本项目有关的其他文档。
】
2.系统说明
2.1系统用途
【说明系统具备的功能,输入和输出。
】
2.2安全保密
【说明系统安全保密方面的考虑。
】
2.3总体说明
【说明系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的方式给出系统主要部分的内部关系。
】
2.4程序说明
【说明系统中每一程序、分程序的细节和特性。
】
2.4.1程序1的说明
2.4.1.1功能
【说明程序的功能。
】
2.4.1.2方法
【说明实现方法。
】
2.4.1.3输入
【说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。
】
2.4.1.4处理
【处理特点和目的,如:
a.用图表说明程序中的运行逻辑流程;
b.程序主要转移条件;
c.对程序的约束条件;
d.程序结束时的出口要求;
e.与下一个程序的通信与联结(运行、控制);
f.由该程序产生并供处理程序段使用的输出数据类型和存放单元;
g.程序运行所用存储量、类型及存储位置等。
】
2.4.1.5输出
【程序的输出。
】
2.4.1.6接口
【本程序与本系统其他部分的接口。
】
2.4.1.7表格
【说
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件工程 指导书 编写 模板