家校通概要设计说明书.docx

资源描述

家校通概要设计说明书.docx

《家校通概要设计说明书.docx》由会员分享，可在线阅读，更多相关《家校通概要设计说明书.docx（38页珍藏版）》请在冰点文库上搜索。

家校通概要设计说明书.docx

家校通概要设计说明书

软件概要设计说明书3

1.引言3

1.1编写目的3

1.2定义3

1.3参考资料3

2.范围3

2.1系统主要目标3

2.2主要软件需求4

2.2.1家长需求4

2.2.2学校需求4

2.2.3教师需求5

2.3设计约束、限制5

2.3.1（数据库）表编号与命名定义5

2.3.2编程规范6

2.3.3注释书写规定10

3.软件系统结构设计15

3.1复审数据流、控制流15

3.2软件体系结构15

3.2.1软件程序结构图15

3.2.2模块命名规则15

3.2.3模块描述15

3.3功能需求追溯21

4.复用策略21

5.数据设计22

5.1数据字典复审22

5.2数据项22

业务信息表d_operation_info22

5.3.数据库结构设计22

5.4.文件设计22

6.接口设计23

6.1.用户界面设计规则23

6.1.1字体23

6.1.2控件23

6.2内部接口设计24

6.3外部接口设计24

7.出错处理设计24

8.系统维护设计25

软件概要设计说明书

SoftwarePreliminaryDesignDescription

1.引言

1.1编写目的

在分析《管理信息系统的基础》上，华迪公司Android项目小组对该系统进行了概要设计。

主要是基于以下目的编写此说明书。

1、对系统概要设计的阶段任务成果形成文档，以便阶段验收、评审，最终的文档验收。

2、对需求阶段的文档再次确认过程，对前一阶段需求没有做充分或错误的提出修改。

3、明确整个系统的功能框架和数据库结构，为下一阶段的详细设计、编码、和测试提供参考依据。

4、明确编码规范和命名规范，统一程序界面。

预期读者：

详细设计人员、概要设计评审小组、研究院领导。

1.2定义

MIS:

管理信息系统

系统:

管理信息系统

质量技术交底：

对一个工程项目开始时提出的要达到的质量要求。

人力强度：

一个工程项目每个时间段投入人力的分布。

1.3参考资料

书

2.范围

2.1系统主要目标

华迪家校通（HwadeeFamiliesSchoolCommunication，简写：

Hwadee-FSC）是指利用无线通信技术和网络技术搭建的家校互通平台，为家校之间提供充分、准确、及时的沟通方式，为全面监控学生和学生成长提供有效的途径，该平台运行于移动终端，家长、学生、教师、领导都可以通过智能手机、平板电脑等媒介进行沟通和信息传递。

2.2主要软件需求

2.2.1家长需求

2.2.1.1子女情况监控

1．可以通过平台查看学生考勤、奖罚、评语、成绩、学生管理、作业等信息

2.2.1.2交流和留言功能

1．能通过文字进行沟通

2．能发送语音进行沟通

2.2.1.3具备二维码扫描功能

2.2.2学校需求

2.2.2.1建立学校微网站

所有用户可以查看学校简介、机构设置、通知、公告、新闻等。

2.2.2.2与学校现有数据对接

将学生的考勤（门禁）、奖罚、评语、成绩、作业信息进行整合。

2.2.2.3信息主动推送

将学生的考勤、奖罚、评语、成绩、学生管理、作业信息推送给家长。

能发布新闻、通知信息，并推送给老师、家长、学生。

2.2.3教师需求

2.2.2.1作业发布

将课后作业信息发送给家长和学生。

2.2.2.2信息交流

能通过平台与家长、学生进行沟通交流，支持语音。

能发布新闻、通知信息，并推送给家长、学生

能发布学生活动照片，所有家长均可以浏览和留言。

采用高稳定、高扩展性的开发平台，建议使用Liferay平台。

客户端支持IOS和Android两种移动操作系统，推荐前期先开发支持Android的移动APP

2.3设计约束、限制

2.3.1（数据库）表编号与命名定义

2.3.1.1表编号定义：

9000

a）.91位，表示表的类型；

1代表码表

2代表数据存放表

3临时表

4视图

2.3.1.2表命名定义：

AB_+表的英文名称

a）.A表示表的性质，

‘无’代表用户表（与业务处理直接相关的表）

S代表系统表（为完成业务而建的对用户非透明的表）

b）.B表示表的类型，

C码表（包含唯一代码，一次性生成，很少改动）

D数据存放表（业务数据、控制、设置、记录系统信息等）

T临时表（程序动态生成）

V视图

c）.表的英文名称表示表的英文名称，可缩写；

d）.举例

用户码表：

c_bank

系统码表：

sc_user

2.3.2编程规范

2.3.2.1对象命名规范

对象类型

序号

项目

前缀

备注

复选框

Cbx

CheckBox

命令按钮

CommandButton

数据窗口

DataWindow

下拉列表框

Ddlb

DropDownListBox

带图标下拉列表框

Ddplb

DropDonwPictureListBox

带格式编辑框

EdistMask

函数

Function

函数对象

Function_Object

图表

Graph

分组框

GroupBox

水平滚动条

Hsb

HScrollBar

线

Line

列表框

ListBox

列表视图

ListView

菜单

多行编辑器

Mle

MultiLineEdit

对象公用函数

ObjectFunction

OLE控件

Ole

OLE

椭圆

Oval

图片

Pic

Picture

图形按钮

PictureButton

带图标列表框

Plb

PictureListBox

无线按钮

RadioButton

矩形

Rectangle

超文本编辑器

Rte

RichTextEdit

圆角矩形

RoundRectangle

对象私有函数

SystemFunction

单行编辑器

Sle

SingleLineEdit

静态文本

StaticText

标签

Tab

树状视图

TreeView

用户对象

UserObject

垂直滚动条

VscrllBar

窗口

Window

管道

Pipe

PipeLine

工程

Project

代理

Pro

Proxy

2.3.2.1.1PBL对象命名

（类+）对象类型前缀+‘_’+对象英文名

如：

uo_process_render

cw_process_ancestor

2.3.2.1.2控件对象命名

对象类型前缀+‘_’+对象英文名

如：

pic_background

sle_password

2.3.2.2变量命名规范

变量类别

序号

项目

前缀

备注

全局变量

Global

共享变量

Shared

实例变量

Instant

局部变量

Local

远端变量

Remote

2.3.2.2.1数据变量类型

序号

项目

前缀

备注

任意类型

Any

大数据

Blob

布尔型

Boolean

字符型

Char,Character

日期型

Date

时间型

Time

日期时间型

DateTime

小数型

Dec

Dec,Decimal

双精度型

Double

整型

Int,Integer

长整型

Long

实型

Real

字符串型

String

无符号整型

Uint,UnsignedInt,UnsignedInteger

无符号长整型

Ulong,UnsignedLong

2.3.2.2.2对象变量类型

序号

项目

前缀

备注

应用

App

Application

复选框

Cbx

CheckBox

命令按钮

CommandButton

数据窗口

DataWindow

下拉列表框

Ddlb

DropDownListBox

带图标下拉列表框

Ddplb

DropDonwPictureListBox

带格式编辑框

EdistMask

函数对象

Function_Object

图表

Graph

分组框

GroupBox

水平滚动条

Hsb

HscrollBar

线

Line

列表框

ListBox

列表视图

ListView

菜单

多行编辑器

Mle

MultiLineEdit

OLE控件

Ole

OLE

椭圆

Oval

图片

Pic

Picture

图形按钮

PictureButton

带图标列表框

Plb

PictureListBox

无线按钮

RadioButton

矩形

Rectangle

超文本编辑器

Rte

RichTextEdit

圆角矩形

RoundRectangle

单行编辑器

Sle

SingleLineEdit

静态文本

StaticText

标签

Tab

树状视图

TreeView

用户对象

UserObject

垂直滚动条

VscrllBar

窗口

Window

连接

Connection

上下文信息

Ctinfo

ContextInformation

上下文关键字

CtKeyword

ContextKeyword

数据存储

DataStore

动态描述区

Ddsa

DynamicDescriptionArea

动态存储区

Dsa

DynamicStagingArea

错误

Err

Error

Internet

Inet

Internet结果

InetResult

InternetResult

邮件会晤层

Mailsession

消息

Msg

Message

OLE对象

OleObject

OLEOject

OLE存储

OleStorage

OLE流

OleStream

管道

Pipe

PipeLine

PB对象

Pbo

PowerObject

剖面

Profiling

服务

Service

定时器

Timing

轨迹树

TraceTree

事务

Trans

Transaction

传输

Transport

2.3.2.2.3变量命名

变量类别+数据类型变量/对象类型变量+‘_’+变量英文名

如：

gs_username

lpic_background

2.3.3注释书写规定

2.3.3.1PBL

a）.PBL注释

PBL库的注释必须标明该库的类别及其功能。

格式：

库类别（10个汉字，不足用‘-’补齐）+功能。

如：

公用库--------------公用函数

业务逻辑-----------汇缴处理

用户界面-----------归集查询分析

b）.PBL内对象注释

PBL内对象的注释应标明该对象所属的业务、作者及其功能。

格式：

所属业务（10个汉字，不足用‘-’补齐）+作者名（3个汉字，不足用‘-’补齐）+‘--’+功能描述

如：

公用函数------------惠兴海--以给定分隔符合并字符串

汇缴处理------------喻兵-----汇缴用户界面，处理正常汇缴业务

2.3.3.2Script注释

a）.注释符号

‘//’

不许使用’/**/’作注释符。

b）.函数注释

每个函数都应描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。

格式：

//Function:

函数名

//Purpose:

用途

//Scope:

作用范围

//Args:

入口参数（列表）类型传值方式含义

//Returns:

返回值类型（可确定值列表）含义

c）.非函数注释

注明该模块的作用

格式：

//功能

d）.程序行间注释

在程序行的每一个处理单元前作注释。

格式：

//注释

e）.注释举例

//Function:

F_FindObject

//Purpose:

按照控件名在可视化主对象中查找主对象内的可视化控件。

//Scope:

Public

//Arguments:

ls_nameStringValue将要查找的控件名

//lpbo_objectPowerObjectValue可视化主对象

//lpbo_findPowerObjectRef存放并返回查找到的控件,返回NULL则表

//示可视化主对象内无控件或可视化主对象不能包含

//控件

//Returns:

BooleanTrue表示找到该控件

//False表示未找到该控件

Integerli_loop,li_total

Windowlw_object

UserObjectluo_object

Stringls_control_name

Objectlo_type

li_loop=1

//取得lpbo_object的类型

lo_type=lpbo_object.TypeOf（）

//根据lpbo_object的类型分别处理

ChooseCaselo_type

CaseWindow!

//Window类型

lw_object=lpbo_object

li_total=UpperBound（lw_object.control[]）

Ifli_total<1Then

SetNull（lpbo_find）

ReturnFalse

EndIf

//查找

DoWhileli_loop<=li_total

ls_control_name=lw_object.control[li_loop].ClassName（）

Ifls_control_name=ls_nameThen

lpbo_find=lw_object.control[li_loop]

ReturnTrue

EndIf

li_loop++

Loop

SetNull（lpbo_find）

ReturnFalse

CaseUserObject!

//UserObject类型

luo_object=lpbo_object

IfNOTluo_object.objecttype=CustomVisual!

Then

SetNull（lpbo_find）

ReturnFalse

EndIf

//可视UserObject类型

li_total=UpperBound（luo_object.control[]）

Ifli_total<1Then

SetNull（lpbo_find）

ReturnFalse

EndIf

//查找

DoWhileli_loop<=li_total

ls_control_name=luo_object.control[li_loop].ClassName（）

Ifls_control_name=ls_nameThen

lpbo_find=luo_object.control[li_loop]

ReturnTrue

EndIf

li_loop++

Loop

SetNull（lpbo_find）

ReturnFalse

EndChoose

//非Window和UserObject类型

SetNull（lpbo_find）

ReturnFalse

2.3.3.3Script书写规范

2.3.3.3.1大小写

a）.大写

以下项目必须用大写书写：

1）.SQL关键字，如：

INSERT、SELECT、USING等

2）.逻辑运算符，如：

NOT、AND、OR等

b）.小写

以下项目必须用小写书写：

1）.各种对象名

2）.各种对象的属性

3）.各种变量

4）.数据表拥有者名称，如：

dba

5）.数据表名

6）.字段名

c）.匈牙利书写法

以下项目必须用匈牙利书写法书写：

1）.用于定义变量的对象类型，如CW_Process_Ancestor

2）.枚举值，如：

KeyF1!

Question!

WriteMode!

3）.除逻辑运算符之外的所有PB关键字

4）.函数名称（包括系统函数、用户函数、外部函数和存储过程）

2.3.3.3.2局部变量声明的位置

局部变量的声明必须写在该模块中所有可执行代码之前（游标定义除外）。

2.3.3.3.3缩进

按照程序处理的层次关系逐级缩进。

缩进符：

[Tab]键。

不许用空格键缩进。

2.3.3.3.4间隔

1）.在定义变量时应在声明类型和变量之间用[Tab]键分隔，使每一项声明的第一个变量尽可能的垂直对齐。

2）.在数学运算符、逻辑运算符的前后两端必须各以一个空格与其两边的部分分隔。

2.3.3.3.5换行

每一条语句占一行或多行，不许在一行中书写一条以上的语句（即在一行上不能有用’;’分开的两条或两条以上的语句）。

2.3.3.3.6分节

根据程序处理中不同的阶段用空行对各个阶段分节（至少一个空行，最多可有两个连续的空行）。

2.3.3.3.7SQL书写规范

a）.分行

每个SQL关键字或短语应占一行，关键字和其后的字段、变量、条件表达式等应以[Tab]键分隔，尽量使关键字后的字段、变量、条件表达式等的第一项垂直对齐。

b）.顺序

1）.操作子句后的字段排列应与字段在数据库中的物理顺序一致

2）.WHERE子句后的条件表达式的排列顺序应与FROM子句中的表的排列顺序相对应，条件表达式中的字段出现顺序应与字段在数据库中的物理顺序一致，但是若条件表达式中的字段存在索引，则条件表达式中的字段出现顺序应与字段在索引中的排列顺序一致

3.软件系统结构设计

3.1复审数据流、控制流

复审需求分析阶段对软件的功能需求的描述（如系统的DFD图和IDEF0图）是否合理和精化。

否则，应在本节进行进一步分解和精化。

3.2软件体系结构

3.2.1软件程序结构图

3.2.2模块命名规则

3.2.2.1功能编号定义：

FXXYY00

a）.F1位，代表功能（FUNCTION）；

b）.XX2位，代表子系统编号；

c）.YY2位，代表子系统下的一级模块编号；

d）.002位，代表二级及二级以下模块的流水编号；

3.2.2.2功能命名定义：

操作+‘_’+操作对象名称如Edit_Person

a）.操作代表实施某一动作，如Edit、Adjust、Query等；

b）.操作对象名称代表操作对象，如Person、Rate、Render等；该位可选；

3.2.3模块描述

3.2.3.1学校微网站

3.2.3.1.1学校简介：

对学校简介和机构进行管理

名称

文件、通知、规范、规定的网上收发

标识

F0101

子系统名称

办公管理

系统

名称

系统（OA）

接　口

说　明

输入

文件、通知、规范、规定等的信息

输出

文件、通知、规范、规定等的信息

功　能

说　明

通过网上收发文件、通知、规范、规定等。

运行环

境说明

用LotesNotes实现。

调用关

系说明

调用模块

办公管理

被调用模块

文件、通知、规范、规定的接收、发送

3.2.3.1.2信息公告：

学校通知、公告、新闻的展示

名称

电子邮件的收发

标识

F0102

子系统名称

办公管理

系统

名称

系统（OA）

接　口

说　明

输入

邮件收发信息

输出

邮件收发信息

功　能

说　明

通过Notes实现电子邮件的收发功能。

运行环

境说明

用LotesNotes实现。

调用关

系说明

调用模块

办公管理

被调用模块

电子邮件的接收、发送

3.2.3.2用户管理

3.2.3.2.1组织机构管理：

将所有组织机构统一管理起来，实现学校、班级机构的属性管理，能够通过统一的界面方便的创建、修改、冻结（毕业班级）组织机构

名称

文件资料分类登记

标识

F0201

子系统名称

文件资料库管理

系统

名称

系统（OA）

接　口

说　明

输入

文件资料基本信息

输出

文件资料基本信息

功　能

说　明

登记文件资料的基本信息，其中级别可分为：

国家、省、市、本公司、各部门和分公司、其他，类别可分为：

行政制度、质量、安全、其他等。

运行环

境说明

用LotesNotes实现。

调

展开阅读全文