设计说明书模板上海工程技术大学.docx

设计说明书模板上海工程技术大学.docx

《设计说明书模板上海工程技术大学.docx》由会员分享，可在线阅读，更多相关《设计说明书模板上海工程技术大学.docx（9页珍藏版）》请在冰点文库上搜索。

设计说明书模板上海工程技术大学

××××—设计说明书

参赛编号：

2017001

参赛学校：

××××

参赛成员：

×××××××××

XXXX年XX月XX日

1简介3

1.1作品创意/项目背景3

1.2项目实施计划3

2总体设计4

2.1系统功能4

2.1.1功能概述4

2.1.2功能说明4

2.2系统软硬件平台4

2.2.1系统开发平台（含开源/第三方工具）4

2.2.2系统运行平台5

2.3关键技术5

2.4作品特色5

3详细设计说明6

3.1系统结构设计6

3.1.1技术架构6

3.1.2功能模块设计6

3.1.3关键功能/算法设计6

3.2数据结构设计6

3.2.1存储数据6

1.数据库6

2.文件存储7

3.2.2接口（模块接口、系统间接口）7

3.2.3关键数据结构7

3.3系统界面设计7

3.3.1界面设计风格7

3.3.2主要功能页面7

3.3.3Web网站页面结构设计7

4系统安装及使用说明9

5总结10

6附录11

6.1名词定义11

6.2参考资料11

6.3源代码清单11

1简介

1.1作品创意/项目背景

【介绍本作品的创意来源，产生背景，作品的主要功能，成果的应用目标等。

】

1.2项目实施计划

【介绍作品创作过程中的人员分工、设计制作进度安排等。

】

2总体设计

【本章对系统实现的功能、开发技术和应用环境进行介绍。

】

2.1系统功能

2.1.1功能概述

【概述系统实现的主要功能，包括系统性能。

需给出系统功能的框架结构图，样例如图1所示。

】

图1系统功能框架图

2.1.2功能说明

【对系统功能分层逐一详细说明。

注意此处给出的是从用户角度看到的功能。

】

2.2系统软硬件平台

2.2.1系统开发平台（含开源/第三方工具）

【介绍系统开发所使用的软件和硬件环境，包括所用到的开源平台、第三方工具。

给出使用操作系统的名称、生产厂家、版本号等。

给出所用开源平台的官方网站、版本，该平台提供的功能。

如关键算法的实现或部分实现调用了第三方工具或源代码，请标出其出处，写明已实现的功能。

给出使用数据库的名称、生产厂家、版本号等。

如使用了多种数据库，则要说明如何实现相互之间的关联。

给出使用的硬件设备，型号、生产厂家等。

】

2.2.2系统运行平台

【介绍系统运行时需要的软件和硬件环境。

指明系统是集中式还是分布式的，说明设备的部署要求。

提供系统通信网络的详细描述,表示系统组件是如何连接的。

说明每台硬件设备上部署的系统软件，包括版本要求】。

2.3关键技术

【介绍作品完成所用到的各项关键技术，包括开发技术和理论技术。

】

2.4作品特色

【重点介绍本作品在创意、开发实现、应用等方面的亮点，有特色的功能，团队重点解决的问题等。

】

3详细设计

【对系统或子系统实现方法进行详细说明。

】

3.1系统结构设计

3.1.1技术架构

【说明系统实现采用的关键技术，B/S、C/S平台和移动平台，说明选用该技术的原因。

使用的关键开发技术框架说明。

】

3.1.2功能模块设计

【给出系统开发的功能模块结构图，并说明系统按照什么原理进行划分，系统将由哪些部分，或层次组成。

用图的形式将各个模块之间的调用关系说明清楚。

如果采用面向过程的开发技术，给出主要的函数结构和调用关系图；如果采用面向对象的方法进行设计，模块调用关系图相当于包（package）图。

】

3.1.3关键功能/算法设计

【给出系统关键功能的实现流程图或算法设计流程图，功能优化的技巧等。

数据库系统如使用了存储过程也应在此进行介绍。

注：

此小节为可选单元，“程序设计应用类”项目必写。

】

3.2数据结构设计

【一般而言数据分为存储数据，交换数据及内部逻辑数据，而前两类数据是系统和外部系统之间，以及系统内部模块间交换用的，内部逻辑数据是模块内为了实现一定的逻辑功能而设计的。

】

3.2.1存储数据

【存储数据是指系统产生的需长期存放在存储介质上的数据，一般系统都将重要数据存放在存储介质上，且存放在存储介质上的数据往往其他系统也可以访问到。

根据存储方式的不同又可以分为数据库和文件等方式。

】

1.数据库

【使用Visio或直接使用数据库管理系统建立系统数据库的数据对象模型。

画出建立的逻辑数据模型E-R图，给出数据字典，即列表说明数据库中每个表及视图的字段、主键、外键、约束和索引等，如表1所示。

注：

此小节为可选单元，“数据库应用系统类”项目必写。

】

表1图书信息表

数据表名:

BookInfo中文描述：

图书信息表

字段名称

字段描述

数据类型

长度

是否允许空

缺省值

备注

BookISBN

图书出版号

varchar

20

N

NULL

主键

BookName

书名

varchar

50

N

NULL

索引

Publish

出版社

varchar

50

Y

NULL

AuthorName

作者名

varchar

30

Y

NULL

Price

图书价格

float

8

N

0.0

2.文件存储

【如果存储方式为文件，应给出文件的路径及读取方式，完整清楚地说明文件的命名规则。

对存放在文件中的数据格式和含义应进行说明。

注：

此小节为可选单元，根据项目实现所选用的数据存储方式选择编写。

】

3.2.2接口（模块接口、系统间接口）

【包含系统间或者模块间用来交换信息用的数据，它是系统接口或者模块接口的一部分，是系统间或者模块间交换信息的桥梁。

交换数据方式也可以分为共享数据（共享文件，共享内存等）、通讯协议、参数传递、抛异常等方式。

无论采用何种方式必须详细说明数据（协议）的格式及含义。

注：

此小节为可选单元，没有使用交换数据的项目不必编写。

】

3.2.3关键数据结构

【指关键信息在内存中的数据存储结构。

如果采用面向对象的程序设计，这里应该给出就是概念数据模型（即类图）。

注：

此小节为可选单元，“程序设计应用类”项目必写。

】

3.3系统界面设计

3.3.1界面设计风格

【给出主页面的视图。

阐述页面的布局，页面的图标设计及其功能说明、图像风格等。

】

3.3.2主要功能页面

【介绍主要功能页面，并简要介绍这些页面的设计特色、操作方法。

】

3.3.3Web网站页面结构设计

【介绍Web网站的页面导航，给出Web网站的页面关系图，如图2所示。

】

注：

此小节为可选单元，“Web网站设计”项目必写。

】

图2Web网站页面结构图

4系统安装及使用说明

5总结

【对作品的创意、开发实现过程进行总结，给出作品的改进方向。

】

6附录

6.1名词定义

【列出本文档中用到的可能会引起混淆的专业术语、定义或缩写的原文。

】

名词/缩写

说明

6.2参考资料

【列出设计说明书中引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，样例如下。

】

[1]计算机软件产品开发文件编制指南.中华人民共和国国家标准GB8567-88.国家标准局，1988年1月7日.

[2]谢希仁.计算机网络（第四版）.大连理工大学出版社，2006.8.

[3]严霄凤,高炽扬.美国联邦信息安全风险管理框架及其相关标准研究.信息安全与通信保密, 2（2009）:

40-44.

[4]SalakhutdinovandGeoffHinton,TrainingadeepautoencoderoraclassifieronMNISTdigits,http:

//www.cs.toronto.edu/~hinton/MatlabForSciencePaper.html,2006.

6.3源代码清单