网评系统概要设计说明书.docx

网评系统概要设计说明书.docx

《网评系统概要设计说明书.docx》由会员分享，可在线阅读，更多相关《网评系统概要设计说明书.docx（11页珍藏版）》请在冰豆网上搜索。

网评系统概要设计说明书

概要设计说明书模板

版本变更记录

版本

文档时间

变更说明

目录

1简介5

1.1目的5

1.2适用范围5

1.3项目背景5

1.4术语5

1.5环境描述5

1.5.1运行环境5

1.5.2开发环境5

1.6参考资料6

2系统概述7

2.1目标7

2.2需求概述7

2.3外部接口7

2.4条件与限制7

3架构设计8

3.1系统架构8

3.2接口设计8

3.3功能模块分解8

3.4目录结构8

3.5部署设计8

4模块概要设计9

4.1<模块编号>功能模块概要设计（面向过程）（模块名称）9

4.1.1功能说明/单元测试要点9

4.1.2界面设计9

4.1.3处理流程9

4.1.4接口设计9

4.1.5数据结构和算法9

4.1.6故障/异常处理9

4.2类1概要设计（面向对象）9

4.2.1类名称9

4.2.2功能描述10

4.2.3类定义10

4.2.4对外接口10

5用户界面设计11

5.1界面设计内容11

5.2界面设计与场景描述11

6数据库设计12

6.1数据库环境说明12

6.2数据库设计的命名规则12

6.3数据库逻辑设计12

6.4数据库物理设计12

6.4.1数据表总汇12

6.4.2数据表A设计12

6.5数据库安全设计13

6.5.1防止用户直接操作数据库的方法13

6.5.2用户帐号密码的加密方法13

6.5.3角色与权限13

6.6数据库管理与维护说明13

7维护设计14

8附录15

8.1附录A－相关文档15

1简介

1.1目的

【概要设计说明书的目的】

1.2适用范围

【概要设计说明书的适用范围】

1.3项目背景

♦任务提出者：

。

♦开发者：

♦最终用户：

具有关键业务的行业用户。

♦实现该软件的环境简述：

基于TCP/IP的局域网、WIN2000/NT/9X操作系统、JAVA、DELPHI、ROSE等开发设计工具。

1.4术语

提供正确理解用户需求所需的全部术语的定义、首字母缩写词和缩略语。

可以通过参考项目词汇表来获取这些信息。

1.5环境描述

1.5.1运行环境

基本硬件配置为CPUPII366以上、内存128M以上、硬盘10G以上、网卡100M；运行软件需求为操作系统WINDOWNS2000/NT/9X。

1.5.2开发环境

语言：

C#、JAVA、JAVASCRIPT；

数据库：

MySql系列；

设计建模工具：

FICEVISIO；

配置工具：

无；

WEB服务器；

操作系统：

其他；

序号

工具名称

工具类型

版本

1.6参考资料

XXX2.3版本开发计划和任务书。

XXX2.3需求规格说明书.doc。

2系统概述

2.1目标

实现网站评比功能，用户可自行上载网站记录，记录通过后台人员审核通过后在网页主页上的“最近更新页面显示”，一共其他主页访问者可浏览其信息，系统维护人员也可根据客户提供资料上载网页信息，网站提供种类的统计分析功能，可按年、按月、按日、按类型、按时间段、按更新、按总共、按满意度等。

2.2需求概述

需求：

页面简洁大方，除功能与页面框架元素外不包含任何广告多余杂质的绿色网站。

可以按时间来查询年、季度、月、周、今天、昨天、前天。

信息有信息类型，信息可以直接连接到相关网站，信息描述可以包含图片与文字，超链，标题，正文，点击率，满意度（界面，使用，功能，人性化，网速），有无广告，有无木马，有无脚本。

需要有页面缓存，每分钟更新一次。

2.2.1菜单

2.3外部接口

查询功能可提供外部接口，但目前不开放

2.4条件与限制

Ø时间约束：

无

Ø资源约束：

无

Ø成本约束：

无

Ø功能范围约束：

无

3架构设计

详细描述系统的设计方案和构架涉及的各部分的功能和原理，以及各部分之间的接口、数据流程、控制流程。

3.1系统架构

系统架构分为5层（当然部分功能页可不采用架构处理，避免繁琐操作，一下会做详细说明）

UI展示层：

用户界面交互性处理，界面业务。

UI交互性业务逻辑层：

页面与页面间业务处理，协调UI展示层，UIUtil网络传输。

UIUtil：

页面公共方法，公共对象。

网络传输层：

网络连接处理，扩展数据分流，业务逻辑层的闭环，封装。

业务逻辑层：

向外提供接口，封装数据处理，数据流程业务处理；

数据处理层：

数据库事务性操作，需要考虑连接MYSQL，SQLServer

3.2接口设计

系统描述系统中的接口关系。

3.3功能模块分解

根据对《软件需求规格说明书》的分析，将系统分解成相对独立的，具有高度复用性的，数据联系简洁的功能模块系列。

如果为面向对象的分析设计方法，在此做整体的类图。

3.4目录结构

详细描述代码的目录结构，web项目的目录结构及页面的样式和框架结构。

3.5部署设计

对系统的部署进行设计。

4模块概要设计

4.1<模块编号>功能模块概要设计（面向过程）（模块名称）

4.1.1功能说明/单元测试要点

该功能/模块的详细说明及单元测试的要点。

4.1.2界面设计

该功能/模块的界面设计。

（如果放在下面的界面设计中，这里则左处说明下面对应的界面）

4.1.3处理流程

用文本或图例说明主要的处理流程。

如果没有的话，填“无”。

4.1.4接口设计

对内、外的主要的函数接口。

如果没有的话，填“无”。

4.1.5数据结构和算法

描述关键的数据结构和算法及函数的设计。

如果没有的话，填“无”。

4.1.6故障/异常处理

对可能出现的异常的描述和处理。

如果没有的话，填“无”。

4.2类1概要设计（面向对象）

4.2.1类名称

描写类的名称。

4.2.2功能描述

描写该类实现的具体的功能。

4.2.3类定义

描写类的定义的属性和方法。

4.2.4对外接口

描写与外部类的接口。

5用户界面设计

5.1界面设计内容

阐述本软件用户界面设计遵循的规范及设计的一些资源、内容。

5.2界面设计与场景描述

说明界面设计文件入口。

界面文件

重要场景描述

6数据库设计

6.1数据库环境说明

1、说明所采用的数据库系统，设计工具，编程工具。

2、详细说明数据库服务器所需配置。

6.2数据库设计的命名规则

1、完整并且清楚的说明本数据库的命名规则。

2、如果本数据库的命名规则与公司的标准不完全一致的话，请作出解释。

6.3数据库逻辑设计

数据库设计人员根据需求文档，创建与数据库相关的那部分实体关系图（ERD）。

如果采用面向对象方法（OOAD），这里实体相当于类（class）。

6.4数据库物理设计

1、主要是设计表结构。

一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。

逻辑设计中的实体大部分可以转换成物理设计中的表，但是它们并不一定是一一对应的。

2、对表结构进行规范化处理（第三范式）。

3、可以采用powerDesiger设计文件代替。

6.4.1数据表总汇

表名

功能说明

表A

表B

6.4.2数据表A设计

表名

列名

中文描述

数据类型（精度范围）

空/非空

约束条件

补充说明

6.5数据库安全设计

提高软件系统的安全性应当从“管理”和“设计”两方面着手。

这里仅考虑数据库的安全性设计。

6.5.1防止用户直接操作数据库的方法

用户只能用帐号登陆到应用软件，通过应用软件访问数据库，而没有其它途径操作数据库。

6.5.2用户帐号密码的加密方法

对用户帐号的密码进行加密处理，确保在任何地方都不会出现密码的明文。

6.5.3角色与权限

确定每个角色对数据库表的操作权限，如创建、检索、更新、删除等。

每个角色拥有刚好能够完成任务的权限，不多也不少。

在应用时再为用户分配角色，则每个用户的权限等于他所兼角色的权限之和。

角色

可以访问的表与列

操作权限

角色A

角色B

6.6数据库管理与维护说明

在设计数据库的时候，及时给出管理与维护本数据库的方法，有助于将来撰写出正确完备的用户手册。

7维护设计

XXX系统的维护设计主要方式：

通过服务器的Web服务界面，可以实施各种维护、升级、系统设置/升级、日志管理、服务管理等。

通过XXX服务器的设置，可以实现自动下发。

8其它设计

本章描述前面没有说明的设计。

9备选方案

本章描述可供备选的设计方案，备选方案供项目组选择参考，在以上主设计无法实施的情况下可从备选方案中选择可行的设计方案。