网站软件结构设计说明书.docx

网站软件结构设计说明书.docx

《网站软件结构设计说明书.docx》由会员分享，可在线阅读，更多相关《网站软件结构设计说明书.docx（43页珍藏版）》请在冰点文库上搜索。

网站软件结构设计说明书

网站软件（结构）设计说明书

一．引言

1．引言

1）将系统划分成物理部分，即程序、文件、数据库、文档、图片等。

2）设计软件结构，即将需求规格转换为体系结构，划分出程序的基本模块组成，确定模块间的相互关系，并确定系统的数据结构。

3）预期的读者：

本说明书是软件体系结构设计的说明书，主要读者群为项目组成员，其次供公司上层（老师）评审，并指导开发人员的开发。

4）本说明书为系统的概要设计说明书，为系统详细的设计的主要依据。

主要读者群为项目组成员，使得项目组内成员对整个系统的主要功能以及其概要的实现手段,有一个宏观的把握，是整个系统最初形，同时也是最基本的引导性文档（软件体系结构设计说明书），将从设计的角度对系统进行综合的描述，使用不同的视图来描述其不同方面。

在本说明书中，将对该说明书的结构进行简要的说明，明确该说明书针对的读者群,指导他们正确的使用该说明书。

2．背景

1）项目名称：

山桐子绿色能源科技有限责任公司

2）项目任务提出者:

黄先生

3）项目负责人：

杨卫

4）开发者：

何文静,先雪莉,王娟,白瑜,杨卫

5）开发工具：

FlashCS4；Dreamweaver8

6）运行平台：

本项目采用WINDOW2000为操作系统

7）适用用户：

所有能上网浏览网页的用户,主要用户是需要山桐子的人群.

3．定义

1）该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。

还有一种可简明的做法，就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。

2）比如:

DL:

登录ZC:

注册GSJJ:

公司简介CPZS:

产品展示SCYF:

生产研发WDDD:

我的订单XWZX:

新闻中心LXWM:

联系我们RCZP:

人才招聘

4．参考资料

列出有关的参考资料，如：

（1）本项目的经核准的计划任务书和需求说明书；

（2）属于本项目的其他已发表的文件；如开发标准书；

（3）本文件中各处引用到的文件资料：

[1]陈元国．需求分析说明书．参考资料书，2013.4

[2]顾正刚．网站规划和建设．机械工业出版社，2010.2

[3]张强．数据库设计说明书．参考资料书，2013.5

二．模块/程序系统的组织结构

根据“需求分析说明书”的功能表及流程图，设计系统功能模块间的组织结构。

用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制和被控制关系.

1.公司简介系统的程序（模块）间的组织结构图

图1公司简介系统的组织结构

2.产品展示系统的程序（模块）间的组织结构图

图2产品展示系统的组织结构

3.生产研发系统的程序（模块）间的组织结构图

图3生产研发系统的组织结构

4.我的订单系统的程序（模块）间的组织结构图

图4我的订单系统的组织结构

5.新闻中心系统的程序（模块）间的组织结构图

图5新闻中心系统的组织结构

6.联系我们系统的程序（模块）间的组织结构图

图6联系我们系统的组织结构

7.人才招聘系统的程序（模块）间的组织结构图

图7人才招聘系统的组织结构

三．网站前、后台各子模块功能间的功能描述及示意图

基于网站整体结构组织图基础上，实现前、后台模块功能的功能描述、设计思路、示意图.

1.公司简介模块

1）功能描述

a前台系统功能描述：

用户可以浏览公司简介。

b后台系统功能描述：

此管理模块包括添加本公司简介，修改本公司简介。

2）设计思路

a前台：

即用户端浏览器，能显示浏览公司简介内容。

b后台：

即管理端浏览器，能实现对公司简介信息的更改。

3）公司简介模块示意图

2.产品展示模块

1）功能描述

a前台系统功能描述：

用户可以浏览所有的产品价格和产品照片及选购产品的优势，也可以选购产品。

b后台系统功能描述：

此管理模块包括添加产品文字信息，修改产品文字信息和价格及产品照片。

2）设计思路

a前台：

即用户端浏览器，能显示浏览产品展示内容。

b后台：

即管理端浏览器，能实现对产品展示信息的更改。

3）产品展示模块示意图

3.生产研发模块

1）功能描述

a前台系统功能描述：

用户可以浏览所有的产品生产研发的详细过程。

b后台系统功能描述：

此管理模块包括添加生产研发信息，修改生产研发文字信息。

2）设计思路

a前台：

即用户端浏览器，能显示产品生产研发的过程的详细内容。

b后台：

即管理端浏览器，能实现对产品生产研发文字信息和照片的更改。

3）产品展示模块示意图

4.我的订单模块

1）功能描述

a前台系统功能描述：

此模块用户可以在浏览所有产品的时候进行选购产品增加到我的订单中，在我的订单中可以查看所有选购的产品，可以删除已选产品。

b后台系统功能描述：

此管理模块包括对订单中的产品进行核对及联系买家，然后发货安排。

2）设计思路

a前台：

即用户端浏览器，能显示以及删除订单中的产品。

b后台：

即管理端浏览器，能实现对我的订单里的产品信息核对及产品信息的回复。

3）产品展示模块示意图

5.新闻中心模块

1）功能描述

a前台系统功能描述：

此模块用户可以通过浏览完成对新闻内容的浏览，新闻内容是分类存放的，用户可以浏览自己感兴趣的新闻的内容。

b后台系统功能描述：

此管理模块可以添加新闻内容模块此模块完成新闻内容的添加的功能。

需要输入要添加新闻的标题，新闻的内容，新闻的类别，发布人的信息等。

2）设计思路

a前台：

即用户端浏览器，能显示所有新闻内容。

b后台：

即管理端浏览器，能实现对新闻的添加、更改、删除、查看的管理。

3）产品展示模块示意图

6.联系我们模块

1）功能描述

a前台系统功能描述：

此模块用户可以看到各种联系方式，也可以通过联系我们的各种方式和我们取得联系，反馈意见，在线留言。

b后台系统功能描述：

此管理模块可以更改联系方式，回复消息。

2）设计思路

a前台：

即用户端浏览器，能显示所有联系方式，可以进行在线留言，反馈意见。

b后台：

即管理端浏览器，能实现对联系方式的更改，回复留言，回复意见。

3）产品展示模块示意图

7.人才招聘模块

1）功能描述

a前台系统功能描述：

此模块可以看到人才招聘的用人条件及岗位招聘信息

b后台系统功能描述：

此管理模块可以更改用人的条件和岗位招聘的信息，对符合条件的招聘者筛选。

2）设计思路

a前台：

即用户端浏览器，能显示用人条件及岗位招聘信息。

b后台：

即管理端浏览器，能实现对人才招聘中用人条件的更改，岗位招聘的信息，比如：

录取人员，面试时间地点。

3）产品展示模块示意图

示例：

网上调查模块

1）功能描述

及时获取市场对我公司要求或希望有，通过在线显示调查结果，快速有效地收集用户的意见及建议。

2）设计思路

前台：

即用户端浏览器，实现网上调查功能，如调查选项、用户选择并提交调查结果、查看调查结果等功能。

后台：

即管理端浏览器，实现调查管理功能，如设置调查选项、设置调查表样式、统计调查结果、显示调查结果。

3）调查模块示意图

四．系统模块功能/功能模块的设计描述

根据“需求分析说明书”及“网站演示版”完成功能功能描述及设计思路，详细描述和网站每一个子模块中的基本功能模块/对象相关联的需求。

①功能描述

描述此功能模块要达到的目标、所采用的方法和技术，可采用IPO图（输入－处理－输出图）的形式。

②输入

◆详细描述该功能的所有输入数据，如：

输入源、数量、度量单位、时间设定和有效输入范围等。

◆指明引用的接口说明或接口控制文件的参考资料。

③处理

定义对输入数据、中间参数进行处理以获得预期输出结果的全部操作。

包括：

◆输入数据的有效性检查（名称、标识、数据类型及格式、有效范围、输入形式）。

◆操作的顺序，包括事件的时间设定。

◆异常情况的响应，例如，溢出、通信故障、错误处理、影响的参数等。

◆用于把输入转换成相应输出的方法。

④输出

◆输出数据的有效性检查（名称、标识、数据类型及格式、有效范围、输出形式）。

◆详细说明该功能的所有输出数据，例如，输出目的地、数量、度量单位、时间关系、有效输出范围、非法值的处理、出错信息等。

◆有关接口说明或接口控制文件的参考资料（录属的上一层模块及下一层模块或程序，说明参数赋值及调用式）。

1．会员登录模块

功能模块名

会员用户登录

所属部门

账户管理部门

开发人员

第五组先先

功能描述

（目的）

输入正确的用户名及密码，经过验证并通过，会员用户就能成功登录，做为会员便可浏览相应页面

使用者

会员、管理员、普通用户

需求程序

DL

前置条件

（限制条件）

会员用户必须先注册成功后成为会员用户后才能成功

界面要求

178px*134px

输入数据

用户名和密码

输入项检查

根据输入用户名和密码通过后台程序DL及其数据库进行验证，查找是否是会员用户及正确的密码

操作序列

（算法或者

处理描述

逻辑流程）

a.通过登录界面输入用户名及密码，点击“登录”按钮；

b.调用后台程序DL，运用DL方法在数据库中进行查找验证用户名和密码；

c.若找到用户名并且密码也正确则成功登录，否则弹出提示框“用户名或密码不正确，请重新输入！

”，并回到登录界面；

d.成功登录后提示“恭喜您登录成功”，进入到XXX界面或XXX页面，用户可以进行公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

1．用户名或密码不正确，请重新输入！

则回到登录界面，并提示用户重新登录

2．当会员静默状态达到10分钟时则会员退出，并提示信息“用户已退出”

后置条件

无购买记录的不能成为会员。

预期结果

用户名和密码不正确，则不能登录，若正确则成功登录。

输出项检查

是否出现提示信息“用户名或密码不正确，请重新输入”,若成功则出现“恭喜您登录成功”。

相关对象

及接口

首页：

用于输入用户名和密码

XXX程序：

进行到XX页面

补充说明

（注释设计）

用户名长度需要6个字符以上。

测试计划

对模块进行测试的计划L：

测试技术要求、输入数据、预期结果、进度安排、人员职责

2．注册会员模块

功能模块名

会员注册

所属部门

账户管理部门

开发人员

第五组先先

功能描述

（目的）

进入本网站后，若想成为会员就点入此模块，完成注册信息的填写后，经过验证并通过，便可成为会员，可浏览相应页面

使用者

会员、管理员、普通用户

需求程序

ZC

前置条件

（限制条件）

成功进入网站后才能成功浏览本模块

界面要求

178px*134px

输入数据

根据用户输入的用户名和密码通过后台程序ZC及其数据库进行验证，查找是否有无重复账户记录。

输入项检查

要符合注册表内的要求

操作序列

（算法或者

处理描述

逻辑流程）

a.成功进入网站后就可以浏览本模块；

b.成功进入网站后若想注册成为会员，就点进此模块进入到注册页面；

c.成功注册后，也可以对公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览及相关操作。

异常/出错

情况及处理

1．两次输入的密码不正确，请用户重新输入！

2．当用户静默状态达到10分钟时则注册页面退出，并提示信息“注册页面已失效”请用户重新进入。

后置条件

和数据库中无重复记录，符合命名要求。

预期结果

会员，管理员，普通用户

输出项检查

符合注册要求后，提示“恭喜你，注册成功”，若不符合要求，提示“请仔细检查所填写内容”

相关对象

及接口

首页：

用于注册新会员

XXX程序：

进行到首页面

补充说明

（注释设计）

成功进入网站后，若想注册为会员，点进注册页面，成功注册后，可以浏览公司首页的内容，以及其他模块的内容及操作。

测试计划

对模块进行测试的计划：

测试技术要求、输入数据、预期结果、进度安排、人员职责

3．公司简介模块

功能模块名

公司简介

所属部门

文字管理部门

开发人员

第五组先先

功能描述

（目的）

成功进入本网站后便可浏览相应页面

使用者

会员、管理员、普通用户

需求程序

GSJJ

前置条件

（限制条件）

成功进入网站后才能成功浏览本模块

界面要求

770px*560px

输入数据

无

输入项检查

没有输入项

操作序列

（算法或者

处理描述

逻辑流程）

a.成功进入网站后就可以浏览本模块；

b.成功进入网站后进入到首页面，用户可以进行公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

无

后置条件

无

预期结果

成功进入网站后，可以浏览本网页，否则不能浏览。

输出项检查

无

相关对象

及接口

首页：

公司简介

补充说明

（注释设计）

成功进入网站后，可以浏览公司简介的内容，以及其他模块的内容及操作。

测试计划

对模块进行测试的计划L：

测试技术要求、输入数据、预期结果、进度安排、人员职责

4．产品展示模块

功能模块名

产品展示

所属部门

文字管理部门

开发人员

第五组先先

功能描述

（目的）

成功进入本网站后便可浏览相应页面

使用者

会员、管理员、普通用户

需求程序

CPZS

前置条件

（限制条件）

成功进入网站后才能成功浏览本模块

界面要求

770px*560px

输入数据

无

输入项检查

没有输入项

操作序列

（算法或者

处理描述

逻辑流程）

a.成功进入网站后就可以浏览本模块；

b.成功进入网站后进入到首页面，用户可以进行公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

无

后置条件

无

预期结果

成功进入网站后，可以浏览本网页，否则不能浏览。

输出项检查

无

相关对象

及接口

首页：

产品展示

补充说明

（注释设计）

成功进入网站后，可以浏览产品展示的内容，以及其他模块的内容及操作。

测试计划

对模块进行测试的计划：

测试技术要求、输入数据、预期结果、进度安排、人员职责

5．生产研发模块

功能模块名

生产研发

所属部门

文字管理部门

开发人员

第五组先先

功能描述

（目的）

成功进入本网站后便可浏览相应页面

使用者

会员、管理员、普通用户

需求程序

SCYF

前置条件

（限制条件）

成功进入网站后才能成功浏览本模块

界面要求

770px*560px

输入数据

无

输入项检查

没有输入项

操作序列

（算法或者

处理描述

逻辑流程）

a.成功进入网站后就可以浏览本模块；

b.成功进入网站后进入到首页面，用户可以进行公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

无

后置条件

无

预期结果

成功进入网站后，可以浏览本网页，否则不能浏览。

输出项检查

无

相关对象

及接口

首页：

生产研发

补充说明

（注释设计）

成功进入网站后，可以浏览生产研发的内容，以及其他模块的内容及操作。

测试计划

对模块进行测试的计划L：

测试技术要求、输入数据、预期结果、进度安排、人员职责

6．我的订单模块

功能模块名

我的订单

所属部门

文字管理部门

开发人员

第五组先先

功能描述

（目的）

成功进入本网站后，必须通过用户登录才可浏览相应页面

使用者

会员、管理员、普通用户

需求程序

WDDD

前置条件

（限制条件）

必须是会员，且成功登录后才可进入网站后，成功浏览本模块

界面要求

770px*560px

输入数据

用户名和密码

输入项检查

根据输入用户名和密码通过后台程序WDDD及其数据库进行验证，查找是否是会员用户及正确的密码

操作序列

（算法或者

处理描述

逻辑流程）

a.成功登录后就可以浏览本模块；

b.成功登录后进入到我的订单页面，用户可以对订单里的产品进行更改，也可以对公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

1．用户名或密码不正确，请重新输入！

则回到登录界面，并提示用户重新登录

2．当会员静默状态达到10分钟时则会员退出，并提示信息“用户已退出”

后置条件

在数据库中有相应的会员信息

预期结果

用户名和密码正确，则成功登录，若不正确则不能登录。

输出项检查

是否出现提示信息“用户名或密码不正确，请重新输入”,若成功则出现“恭喜您登录成功”。

删除产品信息后提示“成功删除产品”。

相关对象

及接口

首页：

我的订单

补充说明

（注释设计）

成功进入网站后，可以浏览我的订单的内容，以及其他模块的内容及操作。

测试计划

对模块进行测试的计划L：

测试技术要求、输入数据、预期结果、进度安排、人员职责

7．新闻中心模块

功能模块名

新闻中心

所属部门

文字管理部门

开发人员

第五组先先

功能描述

（目的）

成功进入本网站后便可浏览相应页面

使用者

会员、管理员、普通用户

需求程序

XWZX

前置条件

（限制条件）

成功进入网站后才能成功浏览本模块

界面要求

770px*560px

输入数据

无

输入项检查

没有输入项

操作序列

（算法或者

处理描述

逻辑流程）

a.成功进入网站后就可以浏览本模块；

b.成功进入网站后进入到首页面，用户可以进行公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

无

后置条件

无

预期结果

成功进入网站后，可以浏览本网页，否则不能浏览。

输出项检查

无

相关对象

及接口

首页：

新闻中心

补充说明

（注释设计）

成功进入网站后，可以浏览新闻中心的内容，以及其他模块的内容及操作。

测试计划

对模块进行测试的计划L：

测试技术要求、输入数据、预期结果、进度安排、人员职责

8．联系我们模块

功能模块名

联系我们

所属部门

文字管理部门

开发人员

第五组先先

功能描述

（目的）

成功进入本网站后便可浏览相应页面，显示联系方式，进行提出意见。

使用者

会员、管理员、普通用户

需求程序

LXWM

前置条件

（限制条件）

必须成功登录后，才能进行意见反馈，在线联系。

界面要求

770px*560px

输入数据

用户名和密码

输入项检查

没有输入项

操作序列

（算法或者

处理描述

逻辑流程）

a.成功进入网站后就可以浏览本模块；

b.成功进入网站后进入到首页面，用户可以进行公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

无

后置条件

无

预期结果

成功进入网站后，可以浏览本网页，否则不能浏览。

输出项检查

根据输入用户名和密码通过后台程序LXWM及其数据库进行验证，查找是否是会员用户及正确的密码

相关对象

及接口

首页：

联系我们

补充说明

（注释设计）

成功进入网站后且成功登录后，可以浏览联系方式，在线留言，意见反馈。

以及其他模块的内容及操作。

测试计划

对模块进行测试的计划L：

测试技术要求、输入数据、预期结果、进度安排、人员职责

9．人才招聘模块

功能模块名

人才招聘

所属部门

文字管理部门

开发人员

第五组先先

功能描述

（目的）

成功进入本网站后便可浏览相应页面，显示用人条件及岗位招聘信息。

使用者

会员、管理员、普通用户

需求程序

RCZP

前置条件

（限制条件）

成功进入网站后才能成功浏览本模块。

界面要求

770px*560px

输入数据

无

输入项检查

没有输入项

操作序列

（算法或者

处理描述

逻辑流程）

a.成功进入网站后就可以浏览本模块；

b.成功进入网站后进入到首页面，可以查看人才招聘的信息。

也可以进行公司简介，产品展示，生产研发，我的订单，新闻中心，联系我们，人才招聘的浏览。

异常/出错

情况及处理

无

后置条件

无

预期结果

成功进入网站后，可以浏览本网页，否则不能浏览。

输出项检查

根据输入用户名和密码通过后台程序RCZP及其数据库进行验证，查找是否是会员用户及正确的密码

相关对象

及接口

首页：

人才招聘

补充说明

（注释设计）

成功进入网站后且成功登录后，可以浏览人才招聘信息，用人条件，岗位招聘信息。

测试计划

对模块进行测试的计划L：

测试技术要求、输入数据、预期结果、进度安排、人员职责

五．程序（标识符）设计说明

1．程序DL

程序名

DL

所属部门

代码管理部门

开发人员

第五组娟娟

程序描述

（目的）

点击登录的时候，成功连接到登录页面。

前置条件

（限制条件）

在首页点击登录后，进入登录页面

输入数据

用户名和密码

输入项检查

用户名的长度及数据库中有相应的数据。

操作序列

（算法或者

处理描述

逻辑流程）

a.获取参数

b.查询数据表获取有无会员、所属栏目、录入时间、模版ID

c.查询数据表获取模版内容

d.替换模版内容中的标签

e.写静态页面

f.查询数据表并获取模版内容

异常/出错

情况及处理

登录错误，提示“请重新登录”

后置条件

和数据有相对应。

预期结果

若成功登录后，提示“登陆成功”，则“重新登录”

输出项检查

若成功登录后，提示“登陆成功”，则“重新登录”

相关对象

及接口

首页：

登录

补充说明

（注释设计）

进入首页后，点击登录。

弹出登录页面。

测试计划

对模块进行测试的计划：

测试技术要求、输入数据、预期结果、进度安排、人员职责

2．程序ZC

程序名

DL

所属部门

代码管理部门

开发人员

第五组娟娟

程序描述

（目的）

点击登录的时候，成功连接到登录页面。

前置条件

（限制条件）

在首页点击登录后，进入登录页面

输入数据

用户名和密码

输入项检查

用户名的长度及数据库中有相应的数据。

操作序列

（算法或者

处理描述

逻辑流程）

a.获取参数

b.查询数据表获取新闻标题、新闻内容、所属栏目、录入时间、模版ID

c.查询数据表获取模版内容

d.替换模版内容中的标签

e.写静态页面

f.查询数据表并获取模版内容

异常/出错

情况及处理

两次输入密码不对，提示“请重新输入”

后置条件

和数据有相对应。

预期结果

如果输入的数据符合,则注册成功,否则注册不成功.

输出项检查

如果输入的数据符合,则提示“注册成功”,否则提示“注册不成功”.

相关对象

及接口

首页:

注册

补充说明

（注释设计）

成功进入首页后,如想注册成为会员,点击注册后,连接到注册页面,进行注册,成功注册后,提示”注册成功”

3．程序GSJJ

程序名

GSJJ

所属部门

代码