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

1、系统设计文档编写规范及示例1*系统系统设计文档*系统设计小组组长：*组员：* * * *说明：在进行系统设计时可以任意传统系统设计方法或面向对象系统设计方法，或者两者相结合，不局限于使用一种方法。文档中每章图都需要配有相应的文字解释。本文档中的图按照章编号，如“1 引言”表示第一章，“1.1 编写目的”表示第一章第一节。第一章第一个图标号为“图1.1 *图”，而第二个图标号为“图1.2 *图”，写在图的下面，居中。本文档中的表也按照章编号，第一章第一个表标号为“表1.1 *表”，而第二个表标号为“表1.2 *表”，写在表的上面，居中。使用visio画用例时，Actor及用例的图示模具（用例图模

2、具.vss）可以到BB平台下载。1 引 言1.1编写目的说明编写这份系统设计说明书的目的，指出预期的读者。1.2背景说明：a待开发的软件系统的名称；b 列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出用得着的参考资料，如：a本项目的经核准的计划任务书或合同、上级机关的批文；b属于本项目的其他已发表的文件；c本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2 系统功能设计2.1 功能模块设计根

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

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

5、备购置申请表5Redeploy设备调拨表（1）试验检测机构综合情况表(TrialOrgan)用来存储试验室机构综合的基本情况，如表4.2所示。表4.2 实验检测机构综合情况表Table 4.2 TrialOrgan属性(英文)类型主键外键空值属性(中文)T_itemidIntYes记录IDT_nodeidchar(6)NoNoNo机构编号T_namevarChar（80）机构名称T_organkindvarChar(20)结构性质T_addressvarChar(100)Yes联系地址5 接口及过程设计针对2.1所设计的模块，尽可能画出每个模块的IPO表。示例如下：IPO表主要说明了销售管理模

6、块各个文件的输入、输出数据流及输入到输出的中间处理过程。销售管理模块每个文件的主要功能的IPO表如表5.1所示。表5.1销售管理模块IPO表子模块名称I(输入)P(处理)O(输出)单位信息维护用户输入单位信息将用户输入的单位信息存储到数据库中在工程信息维护中显示供用户选择工程信息维护用户输入工程信息将用户输入的工程信息存储到数据库中在合同信息维护中供用户选择。6 界面设计说明：一般情况下，一个较大的功能模块会包含多个界面，针对每个功能模块列出界面的转换关系；列出主界面以及几个典型界面的界面设计结果。界面转换关系示例如下：进入销售管理模块后，可以通过主界面左侧的导航进入到各个子模块，每个子模块文

7、件之间的跳转与包含关系如图6.1所示。图中没有连线的文件之间是相互独立的。图4.1 销售管理模块跳转与包含关系图界面设计结果示例如下：系统采用多文档窗体结构，如图4.2所示，在主窗体上分为菜单栏、通用工具栏、导航栏、操作工具栏和工作窗口区五个部分。不同喜好风格的用户可以根据自己的使用风格使用这个系统。菜单和通用工具栏同普通系统一样，提供了系统的全部操作功能的接口；导航栏使用了非常直观的树视图结构，整个功能一幕了然，在树视图中包含部门列表和小组列表，查看、维护部门和小组信息非常方便。图图4.2 主窗口界面图(2) 工作窗口中大量使用表格结构显示数据，这样设计使窗口装载的信息量大，便于用户的浏览多

8、条信息；对于字段数量较多的表格，选择右键弹出菜单中的“查看详细信息”选项（或双击要查看的信息条目）将弹出这个条目的详细信息选项卡，如图4.3所示，用户可以很直观的查看条目的详细信息。图4.3 员工基本信息卡片窗口(3) 统一的操作工具栏，对于每个可以转载数据信息的窗体，都使用由主窗体提供的统一的操作工具栏来进行数据信息的浏览和维护操作，系统将首先根据是哪个数据窗体的请求来选择相应的操作。例如，在图4.3中，可以通过点击操作工具栏中的“首条”、“”上条、“下条”、“尾条”按钮来移动当前记录；用户可以通过点击“查询”按钮来弹出相应的查询窗口，如在此时将弹出查询员工信息窗体，供用户操作；可以通过点击

9、“添加”按钮来弹出相应的添加窗口；可以通过点击“修改”按钮来修改相应的条目。(4) 使用主子表结构显示具有类似主子关系的表格，例如，图4.4中的员工工基本信息表和员工工作时间安排表，这使用户的浏览或维护工作更加直观。图4.4 员工工作时间安排窗口(5) 大量使用帮助信息，在设计这个系统时，仔细的学习了Windows的界面设计风格，在窗口内提供了大量的标签帮助信息，使用户更能理解操作的意义，同时窗口状态栏内也随时显示给用户“即时”的帮助信息。7 其它设计说明：其它设计包含：代码设计、数据结构设计、出错设计等比部分内容不是必须的。代码设计示例：合同代码格式如图7.1所示。图7.1 合同代码格式合同代码采用的是字符+年份+分隔符+3位数字的混合形式，其中合同类型分为：正式合同（HT）、临时合同（LS）、口头合同（KT），每年的合同不超过1000条，在数据库中建立存储过程，根据年份，自动生成对应年份的各种合同顺序号。8 小 结对系统设计结果进行总结。