软件概要设计说明书实用模板.docx
《软件概要设计说明书实用模板.docx》由会员分享,可在线阅读,更多相关《软件概要设计说明书实用模板.docx(7页珍藏版)》请在冰豆网上搜索。
软件概要设计说明书实用模板
研制令号
日期
项目
软件概要设计说明书
(该文档仅供内部参考)
负责单位:
研发部门名称
协作单位:
协作单位名称(如有)
作者:
研发人员签名
批准:
研发部门主任签名
修改及签收情况记录:
版本号
修改人
修改日期
修改批准人
部门资料室签收
研发人员签名
研发部门主任签名
部门资料员存档签名
**********股份有限公司
摘要
描述文档的主要内容。
修改历史
日期
版本
作者
修改内容
xxxx-xx-xx
x.x
xxx
本模板在格式上有以下的一系列约定:
a)用“<>”括起来的内容,是编写指导,在最终的文档中应予以删除。
其它内容应予以保留。
b)如果某章节内容无需填写,而且本模板没有特殊说明的话,则在该章节下写“无”,而不要将该节删除或不填写任何内容。
第一篇概述
1范围
本文件规定了XX(产品型号、规格)XX(产品名称)的软件总体设计、系统运行配置与应用方式以及使用的关键技术等。
本文件适用于XX(产品型号、规格)XX(产品名称)的开发研制工作。
2设计依据
<要求:
列出设计的依据,如有关的国际标准(例如:
ITU-T的建议)、国家标准、行业标准、企标和有关的法规及文件。
>
3术语、定义和缩略语
3.1术语、定义
<要求:
逐项列出本文中用到的难以理解或可能引起混淆的术语及其定义。
>
3.2缩略语
本文件应用了以下缩略语:
<要求:
逐项列出本文中用到的缩略语及其原文和汉语含义。
>
第二篇系统总体设计
4系统体系结构
<要求:
用框图形式描述系统的软件总体框架结构,并对此进行详细说明,简述各子系统或模块之间的关系。
说明:
软件系统的体系结构应该分为系统总体→子系统→模块。
没有子模块和分系统的概念。
对于较小的软件系统可以没有子系统,直接是系统总体→模块。
>
5体系结构概述
<要求:
说明在进行软件总体设计时的基本考虑。
说明采用何种设计方法对系统进行分解。
必要时,可将所考虑过的多个总体设计作对比分析。
对于从已有系统发展出来的系统,须说明其对已有系统体系结构的继承;对于参照了其他系统的体系结构设计的新系统,须说明其对参照系统的体系结构的继承。
对于系统中被各个子系统使用的公用模块,须说明公用模块的实现
注:
设计师可根据系统自身特点或复杂程度划分系统。
系统可由子系统/模块直接组成。
子系统部分还可根据实际情况进行迭代划分。
6标准化设计
6.1模块标准化设计
<要求:
1)说明标准模块查询结果,并说明系统将引用的标准模块和他们在系统中的应用方式
2)说明本系统准备将哪些子系统/模块进行标准化,供其它产品/项目使用。
>
6.2接口标准化设计
<要求:
1)说明本系统准备将哪些子系统/模块间接口标准化,以及该接口标准化的意义(例如可以为本项目后续版本开发制定哪些接口约束提高产品互换性或者提高其它产品/项目研发质量和效率等)
>
7系统版本规划
<要求:
说明本系统生命周期内版本研发规划,包括说明每个子系统的研发规划和相应版本。
>
8系统处理流程
<要求:
用图或文字的方式说明系统关键的处理流程,描述各个处理流程所涉及的子系统或模块以及他们需要进行的处理>
9子系统说明
9.1子系统1(名称)
<要求:
说明该子系统所实现的功能以及对该子系统在性能、可靠性、可维护性、可移植性、安全性以及扩展性方面的要求。
简述子系统的实现方案>
9.2子系统2(名称)
10开发和运行环境
10.1硬件环境
<要求:
1)说明开发本软件系统所需的硬件环境,如计算机、存储设备、网络设备等。
2)说明本软件系统对实际运行硬件环境的最低要求及适用范围。
>
10.2软件环境
<要求:
1)说明开发本软件系统所需的软件环境,如操作系统、数据库系统、程序设计语言、等。
2)必要时,说明本软件系统运行在怎样的软件支撑环境下。
3)必要时,说明本软件系统可支持的其他软件开发。
>
10.3外购件分析
<要求:
1)说明开发本软件系统所需的外购软件,如开发工具、开发组件等。
2)说明外购件的原因与必要性。
>
11可靠性设计
<要求:
说明本软件系统对于可能发生的异常情况需要采用的软件可靠性设计技术。
比如:
1)硬件发生局部故障时,软件采用何种可靠性设计技术,保证整个系统的正常工作;
2)用户误操作或非法操作时,软件采用何种可靠性设计技术,防止系统瘫痪;
3)对于关键程序和数据,采用何种软件可靠性设计技术,提高其可靠程度。
>
12可测试性设计
<要求:
说明本软件系统进行模块测试、子系统测试、系统测试等测试时,设置测试点的技术。
1)明模块中测试设计原理,测试接口,测试内容和范围。
2)明子系统中测试设计原理,测试接口,测试内容和范围。
3)说明系统中测试设计原理,测试接口,测试内容和范围。
>
13安全性设计
<要求:
分析产品可能发生的危险的严重性等级和可能性等级,进行系统危险分析和防范。
如:
1)为防止盗版和防止非法用户进入系统所采用的加密技术;
2)对重要数据和信息所采用的加密技术;
3)系统数据的备份和恢复,以及系统数据一致性的校验等设计。
>
第三篇系统运行说明
14配置说明
<要求:
说明系统具备几种配置或工作方式,每种配置完成功能的区别。
>
15系统应用方式
<要求:
说明系统在实际应用中能提供哪些应用方式,例如:
可应用到哪些场合和设备中,如何与别的设备配合以满足用户的要求。
>
16代码目录说明
编写代码目录树结构规划,例:
|---include
||---ScheDraw
|||---Components
|||---Tools
|||---Commands
|||---Graphic
|---src
||---ScheDraw
||---ScheMaker
||---ScheViewer
|---bin
|---lib
第四篇关键技术问题说明
17关键技术问题说明
<要求:
说明系统在设计和开发过程中,需掌握哪些关键技术(包括关键组件的获得等),有哪些技术难点和不确定的技术问题,说明对这些关键技术的解决方案,是否有专利限制,并分析技术上的风险(系统设计、软件质量、项目进度方面的风险)等。
>
第五篇总体进度计划
18进度计划
18.1项目分解
<把产品的研制开发分解为若干工作项目,列出完成它们必须的先后工作关系。
>
18.2完成时间
<规定每一工作项目完成的时间范围及工作项目的资源保证。
>
第六篇
参考文献
19参考文献
<要求:
列出编写本文件时的参考资料。
>