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

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

********系统

系统设计文档

*****系统设计小组

组长：

****

组员：

****

****

****

****

目

录

1引

言.................................................................................................................................................................11.1编写目的.................................................................................................................................................11.2背景..........................................................................................................................................................11.3定义..........................................................................................................................................................21.4参考资料.................................................................................................................................................22系统功能设计...................................................................................................................................................32.1功能模块设计.......................................................................................................................................32.2****模块设计.........................................................................................................................................32.3****模块设计.........................................................................................................................................33类设计.................................................................................................................................................................44数据库设计........................................................................................................................................................65接口及过程设计..............................................................................................................................................86界面设计............................................................................................................................................................97其它设计..........................................................................................................................................................138小

结...............................................................................................................................................................14

说明：

在进展系统设计时可以任意传统系统设计方法或面对对象系统设计方法，或者两者相结合，不局限于使用一种方法。

文档中每章图都需要配有相应的文字解释。

本文档中的图根据章编号，如“1引言”表示第一章，“1.1编写目的”表示第一章第一节。第一章第一个图标号为“图1.1****图”，而其次个图标号为“图1.2****图”，写在图的下面，居中。

本文档中的表也根据章编号，第一章第一个表标号为“表1.1****表”，而其次个表标号为“表1.2****表”，写在表的上面，居中。

使用visio画用例时，Actor及用例的图示模具（用例图模具.vss）可以到BB平台下载。

11

引

言

11.1编写目的说明编写这份系统设计说明书的目的，指出预期的读者。

21.2背景说明：

a．待开发的软件系统的名称；

b．列出此工程的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。

31.3定义列出本文件中用到的特地术语的定义和外文首字母组词的原词组。

41.4参考资料列出用得着的参考资料，如：

a．本工程的经核准的规划任务书或合同、上级机关的批文；

b．属于本工程的其他已发表的文件；

c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

22

系统功能设计

2.1功能模块设计依据分析工作进展系统的功能安排，画出系统的功能模块图（假如使用面对对象系统设计方法，可以画包图）。功能层次图例如：

图2.1功能模块图2.2

****模块设计列出该模块及该模块所包含的每个子模块的功能。

****子模块：包含。。。。。。。等功能。

****子模块：包含。。。。。。。等功能。

。。。。。。。。。。

2.3

****模块设计。。。。。。。。。。。。。。。。。。。。。。。

3类设计

说明：

假如使用面对对象系统设计方法，需要进展类设计。

此局部内容不是必需的。

尽可能列出所设计出的类及其之间的关系，假如类比拟多，可以根据第2章所设计的模块（或包）分别画类图。

例如如下：

例如1：网上商店系统中登录模块的类图如图3.1所示。。。。。。。。。。

图3.1系统登录模块类图例如2：数据上传模块类图如图3.2所示。

图3.2违章数据上传模块类图

4数据库设计

说明：

假如使用面对对象需求分析方法，需要建立对象-关系模型。

此局部内容不是必需的。

依据系统需求分析结果尽量画出E-R图（E-R图不是必需的），并依据这些工作设计出实现系统功能所需要的数据库表的构造。并以表格的形式尽可能列出每一个数据库表的表构造，即字段名、类型、长度、小数位数、是否主键、索引、是否允许为空、说明等。介绍表与表之间的规律关系。

例如：

系统中数据库包括如下各表如表4.1所示。

表4.1系统数据库表序号表名(英文)说明1Trialorgan试验检测机构综合状况表2Personinfo试验检测人员根本信息表3Trialinfo试验根本信息表4Purchaseapply设备购置申请表5Redeploy设备调拨表

（1）试验检测机构综合状况表(TrialOrgan)用来存储试验室机构综合的根本状况，如表4.2所示。

表4.2试验检测机构综合状况表Table4.2TrialOrgan属性(英文)类型主键外键空值属性(中文)T_itemidIntYes

记录ID

T_nodeidchar(6)NoNoNo机构编号T_namevarChar（80）

机构名称T_organkindvarChar(20)

构造性质T_addressvarChar(100)

Yes联系地址

55

接口及过程设计

针对2.1所设计的模块，尽可能画出每个模块的IPO表。

例如如下：

IPO表主要说明白销售治理模块各个文件的输入、输出数据流及输入到输出的中间处理过程。销售治理模块每个文件的主要功能的IPO表如表5.1所示。

表5.1销售治理模块IPO表子模块名称I(输入)P(处理)O(输出)单位信息维护用户输入单位信息将用户输入的单位信息存储到数据库中在工程信息维护中显示供用户选择工程信息维护用户输入工程信息将用户输入的工程信息存储到数据库中在合同信息维护中供用户选择。。。

。。。

。。。

。。。

66

界面设计

说明：

一般状况下，一个较大的功能模块会包含多个界面，针对每个功能模块列出界面的转换关系；

列出主界面以及几个典型界面的界面设计结果。

界面转换关系例如如下：

进入销售治理模块后，可以通过主界面左侧的导航进入到各个子模块，每个子模块文件之间的跳转与包含关系如图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中，可以通过点击操作工具栏中的“首条”、“”上条、“下