软件系统设计报告模板
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
项目名称
软件系统设计报告
姓名:
学号:
班级:
日期:
目录
0.文档说明 (1)
0.1设计文档的目的和文档使用范围; (1)
0.2文档的读者; (1)
0.3参考资料; (1)
0.4缩略语; (1)
1.系统概述 (2)
1.1系统部署图 (2)
1.2硬件环境 (2)
1.3软件环境 (3)
1.3.1OS环境 (3)
1.3.2依赖软件 (3)
1.3.3开发环境 (3)
1.4系统安装 (3)
1.5系统启动 (3)
1.6系统退出 (4)
2.关键技术 (5)
2.1技术点描述 (5)
2.1.1XXX1技术点 (5)
2.1.2XXX2技术点 (5)
2.2关键算法描述 (5)
2.2.1YYY1关键算法 (5)
2.2.2YYY2关键算法 (6)
3.结构设计 (7)
3.1软件架构图 (7)
3.2模块关系图 (9)
3.3模块功能说明 (9)
3.4系统的初始化、退出描述 (9)
3.5系统状态图 (11)
4.并发设计 (13)
4.1线程结构 (13)
5.模块内设计 (15)
5.1XX模块设计 (15)
5.1.1类的关系图 (15)
5.1.2类的说明 (15)
5.1.3接口说明 (16)
5.1.4算法描述 (16)
5.2YY模块设计 (16)
0.文档说明
0.1设计文档的目的和文档使用范围;
简要描述这个文档的编写目的和使用范围。
正文。
0.2文档的读者;
描述这个文档的读者。
正文。
0.3参考资料;
与本设计相关的资料。一般是指设计依据的资料。如:
0.4缩略语;
定义重要的术语、缩写词或缩略语;
1.系统概述
主要从系统需求的角度,描述系统;描述的输入是用户需求(式样)。
正文。
1.1系统部署图
给出系统部署图,并进行简要说明。使用Visio描画,表示方法参见图例。
图例参见:Microsoft Word
文档
例图如下:
图 1 –系统部署图下面应该对部署图进行说明。
正文。
1.2硬件环境
描述系统的硬件环境:以及对系统有影响的关键硬件信息。
正文。
1.3软件环境
描述系统的软件环境:OS、以及对系统正常工作提供支持的所有软件对象(如3D的插件等);
以及使用到的第三方接口。
1.3.1OS环境
说明操作系统及其版本号。
1.3.2依赖软件
说明依赖软件、组件、服务信息。
1.3.3开发环境
说明开发工具等信息。
1.4系统安装
描述对系统安装方法/方式的考虑,如提供那些安装方法/方式。
正文。
1.5系统启动
描述系统启动的操作步骤。
正文。
1.6系统退出
描述系统退出的操作步骤。
正文。
2.关键技术
描述采用的新技术、新的技术方向(如VOIP),以及可能带来的风险或技术难点。
先应该描述技术点(表)和关键算法(表)。然后对每个技术点和算法进行描述。
技术点列表如下:
状态包括:掌握、了解、了解中;用于跟踪是否存在风险。
关键算法列表如下:
2.1技术点描述
逐个对技术点进行描述。描述每个技术点的内容、解决方法、状态等。
正文。
2.1.1XXX1技术点
正文。
2.1.2XXX2技术点
正文。
2.2关键算法描述
逐个对关键算法进行描述。对每个算法进行详细说明。
2.2.1YYY1关键算法
正文。
2.2.2YYY2关键算法
正文。
3.结构设计
3.1软件架构图
描述系统的软件架构图,并对图中的模块进行说明。
使用UML的包图或Visio图描述软件架构图,软件架构图的描述方法参照图例。
软件架构图主要体现系统的内部架构,及与外部的关系。
内部重点描述模块组成(层次)关系,对于小系统,一般架构图就可以描述全部模块的关系,因此也就不需要后续的模块关系图。如果系统比较大,此处可以只画出系统中的一级模块,更详细的结构在后面的模块关系图中描述。
与外部的关系,主要表达与那些外部对象进行交互,以及如何与外部进行交互的。
例图如下:
图 2 –软件架构图以下对软件架构图进行描述。
正文。
3.2模块关系图
请画出模块关系图。
使用包图描述,模块关系图的描述方法参照软件架构图的图例。
模块关系图主要体现系统的内部架构。重点描述模块组成(层次)关系,对于小系统,一般架构图就可以描述全部模块的关系,因此也就不需要模块关系图。
根据需要,模块关系图中的某个(些)模块还可以放大,进行更进一步的描述。
正文。
3.3模块功能说明
请参照模块关系图,将各个模块功能进行详细说明。如,
3.4系统的初始化、退出描述
请使用时序图描述系统初始化、退出的处理过程。
使用Rose或Visio描述时序图,描述方法参照图例。
时序图的对象应该是对象或者模块。