系统设计文档编写规范及示例

****************系统系统 系统设计文档系统设计文档 **********系统设计小组系统设计小组 组长：组长：******** 组员：组员：******** **** **** **** **** **** **** 目目录录 1 引言.1 1.1 编写目的.1 1.2 背景.1 1.3 定义.1 1.4 参考资料.1 2 系统功能设计.3 2.1 功能模块设计3 2.2 ****模块设计.3 2.3 ****模块设计.3 3 类设计.4 4 数据库设计.6 5 接口及过程设计.7 6 界面设计.8 7 其它设计.12 8 小结.13 - I - 说明： 在进行系统设计时可以任意传统系统设计方法或面向对象系统设计方在进行系统设计时可以任意传统系统设计方法或面向对象系统设计方 法，或者两者相结合，不局限于使用一种方法。法，或者两者相结合，不局限于使用一种方法。 文档中每章图都需要配有相应的文字解释。文档中每章图都需要配有相应的文字解释。 本文档中的图按照章编号，如“1 引言”表示第一章， “1.1 编写目的” 表示第一章第一节。第一章第一个图标号为“图 1.1 ****图” ，而第二个 图标号为“图 1.2 ****图” ，写在图的下面，居中。 本文档中的表也按照章编号，第一章第一个表标号为“表 1.1 ****表” ， 而第二个表标号为“表 1.2 ****表” ，写在表的上面，居中。 使用 visio 画用例时，Actor 及用例的图示模具（用例图模具.vss）可以到 BB 平台下载。 1 1 引引言言 1.11.1 编写目的编写目的 说明编写这份系统设计说明书的目的，指出预期的读者。 1.21.2 背景背景 说明： a．待开发的软件系统的名称； b． 列出此项目的任务提出者、 开发者、 用户以及将运行该软件的计算站 （中心） 。 1.31.3 定义定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.41.4 参考资料参考资料 列出用得着的参考资料，如： - 1 - a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出 这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这 些文件资料的来源。 - 2 - 2 2 系统功能设计系统功能设计 2.12.1 功能模块设计功能模块设计 根据分析工作进行系统的功能分配，画出系统的功能模块图（如果使用面向 对象系统设计方法，可以画包图） 。功能层次图示例： 图 2.1 功能模块图 2.2 ****2.2 ****模块设计模块设计 列出该模块及该模块所包含的每个子模块的功能。 ****子模块：包含。 。 。 。 。 。 。等功能。 ****子模块：包含。 。 。 。 。 。 。等功能。 。 。 。 。 。 。 。 。 。 。 2.3 ****2.3 ****模块设计模块设计 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 - 3 - 3 3 类设计类设计 说明： 如果使用面向对象系统设计方法，需要进行类设计。 此部分内容不是必须的。 尽可能列出所设计出的类及其之间的关系，如果类比较多，可以按照第2 章所设计的模块（或包）分别画类图。 示例如下： 示例 1：网上商店系统中登录模块的类图如图 3.1 所示。 。 。 。 。 。 。 。 。 。 图 3.1 系统登录模块类图 - 4 - ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister 示例 2：数据上传模块类图如图 3.2 所示。 ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister c class Systemlass System IllegalDataDllIllegalDataDllDataUploadDataUpload ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister - - - m_typeNum :int- - _strCameraIP :string ··· ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister -m_hThread :HANDLE-_strServerIP :string m_isContinue :bool ··· + + # # # start(string) :bool stop() :bool XmlFileEnumerate(int, vector&, LPSTR) :void IrregalDateUpload() :void ···() +UnInitialize() :int +OnTimer(unit) :void +···() ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister +Initialize() :bool ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister ered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregister - - - - m_steq_lock :CRIT