软件系统设计报告

项目名称软件系统设计报告姓名：学号：班级：日期：目录TOC\o"1-3"\h\z0. 文档阐明 10.1 设计文档的目的和文档使用范畴； 10.2 文档的读者； 10.3 参考资料； 10.4 缩略语； 11. 系统概述 21.1 系统布署图 21.2 硬件环境 21.3 软件环境 31.3.1 OS环境 31.3.2 依赖软件 31.3.3 开发环境 31.4 系统安装 31.5 系统启动 41.6 系统退出 42. 核心技术 52.1 技术点描述 52.1.1 XXX1技术点 52.1.2 XXX2技术点 52.2 核心算法描述 52.2.1 YYY1核心算法 52.2.2 YYY2核心算法 63. 构造设计 73.1 软件架构图 73.2 模块关系图 93.3 模块功效阐明 93.4 系统的初始化、退出描述 93.5 系统状态图 114. 并发设计 134.1 线程构造 135. 模块内设计 155.1 XX模块设计 155.1.1 类的关系图 155.1.2 类的阐明 155.1.3 接口阐明 165.1.4 算法描述 165.2 YY模块设计 16文档阐明设计文档的目的和文档使用范畴；简要描述这个文档的编写目的和使用范畴。正文。文档的读者；描述这个文档的读者。正文。参考资料； 及本设计有关的资料。普通是指设计根据的资料。如：编号有关文档1UniMed4.0系统框架设计报告.doc2表格SEQ表格\*ARABIC1–参考资料缩略语； 定义重要的术语、缩写词或缩略语；缩略语、术语全称、解释表格SEQ表格\*ARABIC2–缩略语系统概述重要从系统需求的角度，描述系统；描述的输入是顾客需求（式样）。正文。系统布署图给出系统布署图，并进行简要阐明。使用Visio描画，表达办法参见图例。图例参见： 例图以下：图SEQ图表\*ARABIC1–系统布署图 下面应当对布署图进行阐明。正文。硬件环境描述系统的硬件环境：以及对系统有影响的核心硬件信息。硬件名称基本规定推荐配备CPU1GPentium1.6GPentium硬盘20G40G内存512M1G显卡显示屏其它 表格SEQ表格\*ARABIC4–系统核心硬件信息正文。软件环境描述系统的软件环境：OS、以及对系统正常工作提供支持的全部软件对象（如3D的插件等）；以及使用到的第三方接口。OS环境阐明操作系统及其版本号。系统名称版本号提供商表格SEQ表格\*ARABIC5–OS环境依赖软件阐明依赖软件、组件、服务信息。软件名称版本号提供商备注表格SEQ表格\*ARABIC6–依赖软件开发环境阐明开发工具等信息。软件名称版本号使用语言提供商备注VisualSC++Microsoft表格SEQ表格\*ARABIC7–开发环境系统安装描述对系统安装办法/方式的考虑，如提供那些安装办法/方式。正文。系统启动描述系统启动的操作环节。正文。系统退出描述系统退出的操作环节。正文。核心技术描述采用的新技术、新的技术方向（如VOIP），以及可能带来的风险或技术难点。先应当描述技术点（表）和核心算法（表）。然后对每个技术点和算法进行描述。技术点列表以下：编号技术点略称状态No.1XXX1No.2XXX2表格SEQ表格\*ARABIC8–技术点列表状态涉及：掌握、理解、理解中；用于跟踪与否存在风险。核心算法列表以下：编号算法略称备注No.1YYY1No.2YYY2 表格SEQ表格\*ARABIC9–核心算法列表技术点描述逐个对技术点进行描述。描述每个技术点的内容、解决办法、状态等。正文。XXX1技术点正文。XXX2技术点正文。核心算法描述逐个对核心算法进行描述。对每个算法进行具体阐明。YYY1核心算法正文。YYY2核心算法正文。构造设计软件架构图描述系统的软件架构图，并对图中的模块进行阐明。使用UML的包图或Visio图描述软件架构图，软件架构图的描述办法参考图例。软件架构图重要体现系统的内部架构，及及外部的关系。内部重点描述模块构成（层次）关系，对于小系统，普通架构图就能够描述全部模块的关系，因此也就不需要后续的模块关系图。如果系统比较大，此处能够只画出系统中的一级模块，更具体的构造在背面的模块关系图中描述。及外部的关系，重要体现及那些外部对象进行交互，以及如何及外部进行交互的。例图以下：图SEQ图表\*ARABIC2–软件架构图下列对软件架构图进行描述。正文。模块关系图请画出模块关系图。使用包图描述，模块关系图的描述办法参考软件架构图的图例。模块关系图重要体现系统的内部架构。重点描述模块构成（层次）关系，对于小系统，普通架构图就能够描述全部模块的关系，因此也就不需要模块关系图。 根据需要，模块关系图中的某个（些）模块还能够放大，进行更进一步的描述。正文。模块功效阐明请参考模块关系图，将各个模块功效进行具体阐明。如, No模块名称概述1Interface此模块重要负责对xml文献进行修改，添加命令行，以及执行xml文献等操作2Navigator负责xml命令的解析及执行3Control脚本API的功效实现模块，被Navigator模块调用4567891011系统的初始化、退出描述请使用时序图描述系统初始化、退出的解决过程。使用Rose或Visio描述时序图，描述办法参考图例。时序图的对象应当是对象或者模块。系统初始化时序图的一种例子以下：图SEQ图表\*ARABIC5–系统初始化时序正文。系统退出的时序图以下：图SEQ图表\*ARABIC6–系统退出时序正文。系统状态图描述系统的状态图。状态图描述办法参考图例。不是全部系统都有状态图，但对于有明显状态变化的系统（例如复杂的画面迁移）需要描述状态图。如果状态图局限性以描述，能够增加状态迁移表进行补充。例图以下： 图SEQ图表\*ARABIC8–系统状态图状态图阐明列表：FromTo事件行为StartWaitInitAPPMgr启动如FCPMgr通讯正常，每隔10秒要一次初始化信息。WaitInitNormal接受到FCPInit包根据屏幕初始化设备信息、初始化AppCtrl和MsgBoxCtrl、启动ADMgr、RollMgr。向应用派发状态变化事件。表格SEQ表格\*ARABIC12–状态迁移表并发设计线程构造描述线程的构成、线程之间的关系、线程及模块关系。使用线程关系图描述线程关系、通过模块线程关系图描述线程的布署。图例参见：1．线程构成：通过线程列表，对线程的职责、生命周期进行阐明；No.线程名职责生命周期1Aca1….全局2Aca2….全局3Aca4….全局表格SEQ表格\*ARABIC14–线程列表2．线程关系。图SEQ图表\*ARABIC9–线程关系图3．线程及模块关系。图SEQ图表\*ARABIC10–线程及模块关系图需要使用文字描述线程及模块的关系，一种模块有那个（些）线程。如Aca1模块中有Aca1线程、Aca2模块中有Aca2线程、Aca5模块中有Aca5线程。正文。模块内设计识别出模块的数据构造Class，以及Class之间的关系，并根据需要，描述状态转化图、算法描述、重要数据构造等核心技术细节。XX模块设计类的关系图请描述类图，描述办法参见图例：图SEQ图表\*ARABIC13–XX模块类关系图类的阐明将类图提及的类的功效进行阐明。ClassListNo.ClassNameDescription1MForm生成初始运行界面2CFindDlg查找类（起到查找字符串功效）3CAboutBox用于显示About对话框4CStringTable备用5CSettingsDlg备用正文。接口阐明列出子模块对外的宏定义、类型定义、枚举定义、构造体和联合体定义。阐明子模块对外的函数。正文。XXX接口InterFaceSpecificationNameCopyBuild()InterfaceDescription从上下载脚本中指定的parttype版本目录到指定目录下。PrototypeCOPYBUILD_EXPORTboolCopyBuild(constTCHAR*buildScript,constTCHAR*partType,constTCHAR*installType,constTCHAR*,constTCHAR*destination)ParameterListNameTypeI／ODescriptionbuildScriptconstTCHAR*IBuild脚本的途径。partTypeconstTCHAR*IpartType类型对应的值，如－1（ANY）installTypeconstTCHAR*IInstal