2023年系统设计文档编写规范及示例.docx

2023年系统设计文档编写规范及示例1 * 系统 系统设计 文档 * 系统 设计 小组 组长： * 组员： * * * * 目 录 1 引 言 . 1 1.1 编写目的 . 1 1.2 背景 . 1 1.3 定义 . 2 1.4 参考资料 . 2 2 系统功能设计 . 3 2.1 功能模块设计 . 3 2.2 *模块设计 . 3 2.3 *模块设计 . 3 3 类设计 . 4 4 数据库设计 . 6 5 接口及过程设计 . 8 6 界面设计 . 9 7 其它设计 . 13 8 小 结 . 14 说明： l 在进展 系统设计 时可以任意传统 系统设计 方法或面对对象 系统设计 方法，或者两者相结合，不局限于使用一种方法。 l 文档中每章图都需要配有相应的文字解释。 l 本文档中的图根据章编号，如“1 引言”表示第一章，“1.1 编写目的”表示第一章第一节。第一章第一个图标号为“图 1.1 *图”，而其次个图标号为“图 1.2 *图”，写在图的下面，居中。 l 本文档中的表也根据章编号，第一章第一个表标号为“表 1.1 *表”，而其次个表标号为“表 1.2 *表”，写在表的上面，居中。 l 使用 visio 画用例时，Actor 及用例的图示模具（用例图模具.vss）可以到BB 平台下载。 1 1 引 言 1 1.1 编写目的 说明编写这份系统设计说明书的目的，指出预期的读者。 2 1.2 背景 说明： a 待开发的软件系统的名称； b 列出此工程的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。 3 1.3 定义 列出本文件中用到的特地术语的定义和外文首字母组词的原词组。 4 1.4 参考资料 列出用得着的参考资料，如： a 本工程的经核准的规划任务书或合同、上级机关的批文； b属于本工程的其他已发表的文件； c 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 2 系统功能 设计 2.1 功能模块设计 依据分析工作进展系统的功能安排，画出系统的功能模块图（假如使用面对对象系统设计方法，可以画包图）。功能层次图例如： 图 2.1 功能模块图 2.2 * 模块设计 列出该模块及该模块所包含的每个子模块的功能。 *子模块：包含。等功能。 *子模块：包含。等功能。 。 2.3 * 模块设计 。 3 类设计 说明： l 假如使用面对对象系统设计方法，需要进展类设计。 l 此局部内容不是必需的。 尽可能列出所设计出的类及其之间的关系，假如类比拟多，可以根据第 2章所设计的模块（或包）分别画类图。 例如如下： 例如 1：网上商店系统中登录模块的类图如图 3.1 所示。 图 3.1 系统登录模块类图 例如 2：数据上传模块类图如图 3.2 所示。 图 3.2 违章数据上传模块类图 4 数据库设计 说明： l 假如使用面对对象需求分析方法，需要建立对象-关系模型。 l 此局部内容不是必需的。 依据系统需求分析结果尽量画出 E-R 图（E-R 图不是必需的），并依据这些工作设计出实现系统功能所需要的数据库表的构造。并以表格的形式尽可能列出每一个数据库表的表构造，即字段名、类型、长度、小数位数、是否主键、索引、是否允许为空、说明等。介绍表与表之间的规律关系。 例如： 系统中数据库包括如下各表如表 4.1 所示。 表 4.1 系统数据库表 序号 表名(英文) 说明 1 Trialorgan 试验检测机构综合状况表 2 Personinfo 试验检测人员根本信息表 3 Trialinfo 试验根本信息表 4 Purchaseapply 设备购置申请表 5 Redeploy 设备调拨表 （1）试验检测机构综合状况表(TrialOrgan) 用来存储试验室机构综合的根本状况，如表 4.2 所示。 表 4.2 试验检测机构综合状况表 Table 4.2 TrialOrgan 属性(英文) 类型 主键 外键 空值 属性(中文) T_itemid Int Yes 记录 ID T_nodeid char(6) No No No 机构编号 T_name varChar（80） 机构名称 T_organkind varChar(20) 构造性质 T_address varChar(100) Yes 联系地址 5 5 接口及过程设计 针对 2.1 所设计的模块，尽可能画出每个模块的 IPO 表。 例如如下： IPO 表主要说明白销售治理模块各个文件的输入、输出数据流及输入到输出的中间处理过程。销售治理模块每个文件的主要功能的 IPO 表如表 5.1 所示。 表 5.1 销售治理模块 IPO 表 子模块名称 I(输入) P(处理) O(输出) 单位信息维护 用户输入单位信息 将用户输入的单位信息存储到数据库中 在工程信息维护中显示供用户选择 工程信息维护 用户输入工程信息 将用户输入的工程信息存储到数据库中 在合同信息维护中供用户选择 。 。 。 。 6 6 界面设计 说明： l 一般状况下，一个较大的功能模块会包含多个界面，针对每个功能模块列出界面的转换关系； l 列出主界面以及几个典型界面的界面设计结果。 界面转换关系例如如下： 进入销售治理模块后，可以通过主界面左侧的导航进入到各个子模块，每个子模块文件之间的跳转与包含关系如图 6.1 所示。图中没有连线的文件之间是相互独立的。 Xsgl_Main.dfmHtxx_Main.dfmHtkz_Main.dfmZwgl_Main.dfmGcxx_Main.dfmFXS_NewPrice.dfmFXS_Pact_Retion.dfmPact_Adjust.dfmZwjs_Main.dfm录入单价跳转销售托付跳转建立工程跳转生产合同跳转合同掌握跳转账务结算跳转账务调整跳转查看账务跳转 图 4.1 销售治理模块跳转与包含关系图 界面设计结果例如如下： 系统采纳多文档窗体构造，如图 4.2 所示，在主窗体上分为菜单栏、通用工具栏、导航栏、操作工具栏和工作窗口区五个局部。不同喜好风格的用户可以根 据自己的使用风格使用这个系统。菜单和通用工具栏同一般系统一样，供应了系统的全部操作功能的接口； 导航栏使用了特别直观的树视图构造，整个功能一幕了然，在树视图中包含部门列表和小组列表，查看、维护部门和小组信息特别便利。 图 图 4.2 主窗口界面图 (2) 工作窗口中大量使用表格构造显示数据，这样设计使窗口装载的信息量大，便于用户的扫瞄多条信息； 对于字段数量较多的表格，选择右键弹出菜单中的“查看具体信息”选项（或双击要查看的信息条目）将弹出这个条目的具体信息选项卡，如图 4.3 所示，用户可以很直观的查看条目的具体信息。 图 4.3 员工根本信息卡片窗口 (3) 统一的操作工具栏，对于每个可以转载数据信息的窗体，都使用由主窗 体供应的统一的操作工具栏来进展数据信息的扫瞄和维护操作，系统将首先依据是哪个数据窗体的恳求来选择相应的操作。例如，在图 4.3 中，可以通过点击操作工具栏中的“首条”、“”上条、“下条”、“尾条”按钮来移动当前记录； 用户可以通过点击“查询”按钮来弹出相应的查询窗口，如在此时将弹出查询员工信息窗体，供用户操作；可以通过点击“添加”按钮来弹出相应的添加窗口；可以通过点击“修改”按钮来修改相应的条目。 (4) 使用主子表构造显示具有类似主子关系的表格，例如，图 4.4 中的员工工根本信息表和员工工作时间安排表，这使用户的扫瞄或维护工作更加直观。 图 4.4 员工工作时间安排窗口 (5) 大量使用帮忙信息，在设计这个系统时，认真的学习了 Windows 的界面设计风格，在窗口内供应了大量的标签帮忙信息，使用户更能理解操作的意义，同时窗口状态栏内也随时显示给用户“即时”的帮忙信息。 7 7 其它设计 说明： l 其它设计包含：代码设计、数据构造设计、出错设计等 l 比局部内容不是必需的。 代码设计例如： 合同代码格式如图 7.1 所示。 合同挨次号年份合同类型H T 2 0 1 4 0 0 1分隔符 图 7.1 合同代码格式 合同代码采纳的是字符+年份+分隔符+3 位数字的混合形式，其中合同类型分为：正式合同（HT）、临时合同（LS）、口头合同（KT），每年的合同不超过1000 条，在数据库中建立存储过程，依据年份，自动生成对应年份的各种合同挨次号。 8 8 小 结 对系统设计结果进展总结。