软件系统设计报告

1、软件系统设计报告项目名称软件系统设计报告姓名：学号：班级：日期：目录1 / 20软件系统设计报告0. 文档说明. 10.1 设计文档的目的和文档使用范围；.10.2 文档的读者；.10.3 参考资料；.10.4 缩略语；.11. 系统概述. 21.1 系统部署图.21.2 硬件环境.21.3 软件环境.31.3.1 1.3.2 依赖软件1.3.3 开发环境1.4 系统安装.41.5 系统启动.41.6 系统退出.42. 关键技术. 52.1 技术点描述.52.1.1 2.1.2 2.2 关键算法描述.62.2.1 2.2.2 3. 结构设计. 73.1 软件架构图.73.2 模块关系图.93.

2、3 模块功能说明.93.4 系统的初始化、退出描述.93.5 系统状态图.114. 并发设计. 134.1 线程结构.135. 模块内设计. 152 / 20软件系统设计报告5.1 XX模块设计.155.1.1 类的关系图5.1.2 类的说明5.1.3 接口说明5.1.4 算法描述5.2 YY模块设计.173 / 20软件系统设计报告文档说明设计文档的目的和文档使用范围；简要描述这个文档的编写目的和使用范围。正文。0.1文档的读者；描述这个文档的读者。正文。0.20.3参考资料；及本设计相关的资料。一般是指设计依据的资料。如：相关文档1 UniMed4.0系统框架设计报告.doc表格 1 参考

3、资料缩略语；0.4定义重要的术语、缩写词或缩略语；语表格 2 缩略语1 / 20软件系统设计报告1.系统概述正文。系统部署图1.1图例参见：例图如下：MPC机Server机数据图 1 系统部署图下面应该对部署图进行说明。正文。硬件环境1.2描述系统的硬件环境：以及对系统有影响的关键硬件信息。基本要求1G Pentium20G推荐配置1.6G Pentium40G硬盘2 / 20软件系统设计报告512M显示器其它表格 3 系统关键硬件信息正文。软件环境1.3以及使用到的第三方接口。OS环境说明操作系统及其版本号。系统名称版本号提供商表格 4OS环境依赖软件说明依赖软件、组件、服务信息。软件名称

4、版本号提供商表格 5 依赖软件开发环境说明开发工具等信息。软件名称版本号 使用语 提供商备注3 / 20软件系统设计报告言C+S表格 6 开发环境系统安装1.41.51.6正文。系统启动描述系统启动的操作步骤。正文。系统退出描述系统退出的操作步骤。正文。4 / 20软件系统设计报告2.关键技术点。技术点列表如下：表格 7 技术点列表状态包括：掌握、了解、了解中；用于跟踪是否存在风险。关键算法列表如下：算法略称表格 8 关键算法列表技术点描述2.1正文。XXX1技术点正文。5 / 20软件系统设计报告XXX2 技术点正文。关键算法描述2.2逐个对关键算法进行描述。对每个算法进行详细说明。YYY1

5、 关键算法正文。YYY2 关键算法正文。6 / 20软件系统设计报告3.结构设计软件架构图3.1描述系统的软件架构图，并对图中的模块进行说明。使用UML软件架构图主要体现系统的内部架构，及及外部的关系。内部重点描述模块组成（层次）关系，对于小系统，一般架构图就可以描述全画出系统中的一级模块，更详细的结构在后面的模块关系图中描述。及外部的关系，主要表达及那些外部对象进行交互，以及如何及外部进行交互的。例图如下：7 / 20软件系统设计报告业务逻辑层IDEManagerBusiProcessorMemoryManager数据访问层DataFacadeFileHandlerSMS DBFileSto

6、re说明：新规模块外部模块图 2 软件架构图以下对软件架构图进行描述。正文。8 / 20软件系统设计报告模块关系图3.2请画出模块关系图。使用包图描述，模块关系图的描述方法参照软件架构图的图例。模块关系图主要体现系统的内部架构。重点描述模块组成（层次）关系，对于小系统，一般架构图就可以描述全部模块的关系，因此也就不需要模块关系图。根据需要，模块关系图中的某个（些）模块还可以放大，进行更进一步的描述。正文。模块功能说明3.3文件进行修改，添加命文件等操作负责xml 命令的解析及执行脚本API调用1011系统的初始化、退出描述3.4请使用时序图描述系统初始化、退出的处理过程。使用Rose或Visi

7、o描述时序图，描述方法参照图例。时序图的对象应该是对象或者模块。9 / 20软件系统设计报告系统初始化时序图的一个例子如下：AaaAbaAcaRead Registry图 3 系统初始化时序正文。系统退出的时序图如下：AaaAbaAcaExit PrepareFree ResourceExit PrepareFree ResourceFree ResourceExit Task10 / 20软件系统设计报告图 4 系统退出时序正文。系统状态图3.5描述系统的状态图。状态图描述方法参照图例。不是所有系统都有状态图，但对于有明显状态变化的系统（例如复杂的画面迁移）需要描述状态图。如果状态图不足以描

8、述，可以增加状态迁移表进行补充。例图如下：复合状态1Wait IniServiceTerminateNormaFCP ErrorServiceTerminateIdleServiceTerminate图 5 系统状态图11 / 20软件系统设计报告状态图说明列表：Wait Init APPMgr启动 如FCPMgr10秒要一次初始化信息。接收到根据屏幕初始化设备信息、初始化AppCtrl和ADMgr、RollMgr。向应用派发状态改变事件。表格 9 状态迁移表12 / 20软件系统设计报告4.并发设计线程结构4.1描述线程的组成、线程之间的关系、线程及模块关系。使用线程关系图描述线程关系、通过

9、模块线程关系图描述线程的部署。图例参见：1线程组成：通过线程列表，对线程的职责、生命周期进行说明；No.生命周期全局.23Aca2Aca4全局全局表格 10 线程列表2线程关系。图 6 线程关系图13 / 20软件系统设计报告3线程及模块关系。111图 7 线程及模块关系图需要使用文字描述线程及模块的关系，一个模块有那个（些）线程。如Aca1模块中有Aca1模块中有Aca2模块中有Aca5线程。正文。14 / 20软件系统设计报告5.模块内设计Class状态转化图、算法描述、主要数据结构等关键技术细节。XX模块设计5.1类的关系图请描述类图，描述方法参见图例：CBusiProcessor111

10、111CMemoryManagerCControlFormCCommonUtils11111111CStackCArrayListStackCDBFacdeCCheckRegVersionCCheckTxtVersionCCheckExeOrDllVersion图 8 XX模块类关系图类的说明将类图提及的类的功能进行说明。MForm 生成初始运行界面123CFindDlg 查找类（起到查找字符串功能）CAboutBox 用于显示About对话框15 / 20软件系统设计报告CStringTab 备用leCSettingsD 备用lg正文。接口说明列出子模块对外的宏定义、类型定义、枚举定义、结构体和联合体定义。说明子模块对外的函数。正文。XXX接口PrototypeCOPYBUILD_EXPORT bool CopyBuild(const TCHAR* buildScript, constTCHAR* partType, const TCHAR* installType, const TCHAR* , constTCHAR* destination)OpartType类型对应的值，如ParameterListII I 的路径。TCHAR*constTCHAR*16