系统设计文档编写规范及示例(1).doc

1、*系统系统设计文档*系统设计小组组长：*组员：*- I -目 录1 引 言 .11.1 编写目的 .11.2 背景 .11.3 定义 .11.4 参考资料 .12 系统功能设计 .32.1 功能模块设计 .32.2 *模块设计 .32.3 *模块设计 .33 类设计 .44 数据库设计 .65 接口及过程设计 .76 界面设计 .87 其它设计 .128 小 结 .13- 1 -说明： 在进行系统设计时可以任意传统系统设计方法或面向对象系统设计方法，或者两者相结合，不局限于使用一种方法。 文档中每章图都需要配有相应的文字解释。 本文档中的图按照章编号，如“1 引言”表示第一章， “1.1 编写

2、目的”表示第一章第一节。第一章第一个图标号为“图 1.1 *图” ，而第二个图标号为“图 1.2 *图” ，写在图的下面，居中。 本文档中的表也按照章编号，第一章第一个表标号为“表 1.1 *表” ，而第二个表标号为“表 1.2 *表” ，写在表的上面，居中。 使用 visio 画用例时，Actor 及用例的图示模具（用例图模具.vss）可以到 BB 平台下载。1 引 言1.1 编写目的说明编写这份系统设计说明书的目的，指出预期的读者。1.2 背景说明：a 待开发的软件系统的名称；b 列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心） 。1.3 定义列出本文件中用到的专门术语

3、的定义和外文首字母组词的原词组。- 2 -1.4 参考资料列出用得着的参考资料，如：a 本项目的经核准的计划任务书或合同、上级机关的批文；b属于本项目的其他已发表的文件；c 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。- 3 -2 系统功能设计2.1 功能模块设计根据分析工作进行系统的功能分配，画出系统的功能模块图（如果使用面向对象系统设计方法，可以画包图） 。功能层次图示例：图 2.1 功能模块图2.2 *模块设计列出该模块及该模块所包含的每个子模块的功能。*子模块：包含。 。 。 。 。

4、。 。等功能。*子模块：包含。 。 。 。 。 。 。等功能。 。 。 。 。 。 。 。 。 。2.3 *模块设计。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。 。- 4 -3 类设计说明： 如果使用面向对象系统设计方法，需要进行类设计。 此部分内容不是必须的。尽可能列出所设计出的类及其之间的关系，如果类比较多，可以按照第 2章所设计的模块（或包）分别画类图。示例如下：示例 1：网上商店系统中登录模块的类图如图 3.1 所示。 。 。 。 。 。 。 。 。 。图 3.1 系统登录模块类图- 5 -示例 2：数据上传模块类图如图 3.2 所示。clas

5、s SystemEA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered

6、Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregis

7、tered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 U

8、nregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA

9、 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Vers

10、ion EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Tria

11、l Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistere

12、d Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unreg

13、istered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2

14、 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version

15、EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Ve

16、rsion EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Tr

17、ial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregiste

18、red Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unr

19、egistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9

20、.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Versio

21、n EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial

22、Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version EA 9.2 Unregistered Trial Version DataUpload- _strCameraIP :string- _strServerIP :string- + Initialize() :bool+ UnInitiali

23、ze() :int+ OnTimer(unit) :void+ ()tagIllegalInfo+ illegalType :int+ imageName_1 :string+ + tagIllegalData() :voidIllegalDataDll- m_typeNum :int- m_hThread :HANDLE- m_isContinue :bool- + start(string) :bool+ stop() :bool# XmlFileEnumerate(int, vector&, LPSTR) :void# IrregalDateUpload() :void# ()MsXML

24、- spXMLDOM :CComPtr- spNodeList :CComPtr- + Load(LPCTSTR) :BOOL+ CreateXML() :BOOL+ FetchSingleNod (LPCTSTR) :CComPtr+ ()DBConnector- m_steq_lock :CRITICAL_SECTION- m_typeNum :int- m_imagePath :string- + Initialize() :int+ UnInitialize() :void+ AddIllegal(wchar_t*) :int# GetImagePath() :bool# Upload

25、Image() :bool# ()图 3.2 违章数据上传模块类图- 6 -4 数据库设计说明： 如果使用面向对象需求分析方法，需要建立对象-关系模型。 此部分内容不是必须的。根据系统需求分析结果尽量画出 E-R 图（E-R 图不是必须的） ，并根据这些工作设计出实现系统功能所需要的数据库表的结构。并以表格的形式尽可能列出每一个数据库表的表结构，即字段名、类型、长度、小数位数、是否主键、索引、是否允许为空、说明等。介绍表与表之间的逻辑关系。示例：系统中数据库包括如下各表如表 4.1 所示。表 4.1 系统数据库表序号 表名( 英文) 说明1 Trialorgan 试验检测机构综合情况表2 Pe

26、rsoninfo 试验检测人员基本信息表3 Trialinfo 试验基本信息表4 Purchaseapply 设备购置申请表5 Redeploy 设备调拨表（1）试验检测机构综合情况表(TrialOrgan)用来存储试验室机构综合的基本情况，如表 4.2 所示。表 4.2 实验检测机构综合情况表Table 4.2 TrialOrgan属性(英文) 类型 主键 外键 空值 属性(中文)T_itemid Int Yes 记录 IDT_nodeid char(6) No No No 机构编号T_name varChar（80） 机构名称T_organkind varChar(20) 结构性质T_ad

27、dress varChar(100) Yes 联系地址- 7 -5 接口及过程设计针对 2.1 所设计的模块，尽可能画出每个模块的 IPO 表。示例如下：IPO 表主要说明了销售管理模块各个文件的输入、输出数据流及输入到输出的中间处理过程。销售管理模块每个文件的主要功能的 IPO 表如表 5.1 所示。表 5.1 销售管理模块 IPO 表子模块名称 I(输入) P(处理) O(输出)单位信息维护 用户输入单位信息将用户输入的单位信息存储到数据库中在工程信息维护中显示供用户选择工程信息维护 用户输入工程信息将用户输入的工程信息存储到数据库中在合同信息维护中供用户选择。 。 。 。 。 。 。 。

28、 。 。- 8 -6 界面设计说明： 一般情况下，一个较大的功能模块会包含多个界面，针对每个功能模块列出界面的转换关系； 列出主界面以及几个典型界面的界面设计结果。界面转换关系示例如下：进入销售管理模块后，可以通过主界面左侧的导航进入到各个子模块，每个子模块文件之间的跳转与包含关系如图 6.1 所示。图中没有连线的文件之间是相互独立的。X s g l _ M a i n . d f mH t x x _ M a i n . d f mH t k z _ M a i n . d f mZ w g l _ M a i n . d f mG c x x _ M a i n . d f mF X S

29、_ N e w P r i c e . d f mF X S _ P a c t _ R e t i o n . d f mP a c t _ A d j u s t . d f mZ w j s _ M a i n . d f m录入单价跳转销售委托跳转建立工程跳转生产合同跳转合同控制跳转账务结算跳转账务调整跳转查看账务跳转图 4.1 销售管理模块跳转与包含关系图界面设计结果示例如下：系统采用多文档窗体结构，如图 4.2 所示，在主窗体上分为菜单栏、通用工具栏、导航栏、操作工具栏和工作窗口区五个部分。不同喜好风格的用户可以根据自己的使用风格使用这个系统。菜单和通用工具栏同普通系统一样，提供了系统的全部操作功能的接口；导航栏使用了非常直观的树视图结构，整个功能一幕了然，在树视图中包含部门列表和小组列表，查看、维护部门和小组信息非常方便。