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

1、家校通概要设计说明书软件概要设计说明书 31.引言 31.1 编写目的 31.2 定义 31.3 参考资料 32.范围 32.1 系统主要目标 32.2 主要软件需求 42.2.1 家长需求 42.2.2 学校需求 42.2.3 教师需求 52.3 设计约束、限制 52.3.1（数据库）表编号与命名定义 52.3.2 编程规范 62.3.3注释书写规定 103.软件系统结构设计 153.1 复审数据流、控制流 153.2 软件体系结构 153.2.1 软件程序结构图 153.2.2模块命名规则 153.2.3模块描述 153.3 功能需求追溯 214.复用策略 215.数据设计 225.1数据

2、字典复审 225.2 数据项 22业务信息表d_operation_info 225.3.数据库结构设计 225.4.文件设计 226.接口设计 236.1.用户界面设计规则 236.1.1 字体 236.1.2 控件 236.2内部接口设计 246.3外部接口设计 247.出错处理设计 248.系统维护设计 25软件概要设计说明书Software Preliminary Design Description1.引言1.1 编写目的在分析管理信息系统的基础上，华迪公司Android项目小组对该系统进行了概要设计。主要是基于以下目的编写此说明书。1、对系统概要设计的阶段任务成果形成文档，以便阶段

3、验收、评审，最终的文档验收。2、对需求阶段的文档再次确认过程，对前一阶段需求没有做充分或错误的提出修改。3、明确整个系统的功能框架和数据库结构，为下一阶段的详细设计、编码、和测试提供参考依据。4、明确编码规范和命名规范，统一程序界面。预期读者：详细设计人员、概要设计评审小组、研究院领导。1.2 定义MIS: 管理信息系统系统: 管理信息系统质量技术交底：对一个工程项目开始时提出的要达到的质量要求。人力强度：一个工程项目每个时间段投入人力的分布。1.3 参考资料书2.范围2.1 系统主要目标华迪家校通（Hwadee Families School Communication，简写：Hwadee-

4、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.

5、2 与学校现有数据对接将学生的考勤（门禁）、奖罚、评语、成绩、作业信息进行整合。2.2.2.3 信息主动推送将学生的考勤、奖罚、评语、成绩、学生管理、作业信息推送给家长。能发布新闻、通知信息，并推送给老师、家长、学生。2.2.3 教师需求2.2.2.1 作业发布将课后作业信息发送给家长和学生。2.2.2.2 信息交流能通过平台与家长、学生进行沟通交流，支持语音。能发布新闻、通知信息，并推送给家长、学生能发布学生活动照片，所有家长均可以浏览和留言。采用高稳定、高扩展性的开发平台，建议使用Liferay平台。客户端支持IOS和Android两种移动操作系统，推荐前期先开发支持Android的移动A

6、PP2.3 设计约束、限制2.3.1（数据库）表编号与命名定义2.3.1.1 表编号定义：9000 a).9 1位，表示表的类型；1 代表码表2 代表数据存放表3 临时表4 视图2.3.1.2 表命名定义：AB_ + 表的英文名称a).A 表示表的性质，无 代表用户表（与业务处理直接相关的表）S 代表系统表（为完成业务而建的对用户非透明的表）b).B 表示表的类型，C 码表（包含唯一代码，一次性生成，很少改动）D 数据存放表（业务数据、控制、设置、记录系统信息等）T 临时表（程序动态生成）V 视图c).表的英文名称 表示表的英文名称，可缩写；d).举例 用户码表：c_bank 系统码表：sc_

7、user2.3.2 编程规范2.3.2.1 对象命名规范对象类型序号项目前缀备注1复选框CbxCheckBox2命令按钮CbCommandButton3数据窗口DwDataWindow4下拉列表框DdlbDropDownListBox5带图标下拉列表框DdplbDropDonwPictureListBox6带格式编辑框EmEdistMask7函数FFunction8函数对象FoFunction_Object9图表GrGraph10分组框GbGroupBox11水平滚动条HsbHScrollBar12线LnLine13列表框LbListBox14列表视图LvListView15菜单MMenu16

8、多行编辑器MleMultiLineEdit17对象公用函数OFObjectFunction18OLE控件OleOLE19椭圆OvalOval20图片PicPicture21图形按钮PbPictureButton22带图标列表框PlbPictureListBox23无线按钮RbRadioButton24矩形RRectangle25超文本编辑器RteRichTextEdit26圆角矩形RrRoundRectangle27对象私有函数SFSystemFunction28单行编辑器SleSingleLineEdit29静态文本StStaticText30标签TabTab31树状视图TvTreeView

9、32用户对象UoUserObject33垂直滚动条VbVscrllBar34窗口WWindow35管道PipePipeLine36工程PProject37代理ProProxy2.3.2.1.1 PBL对象命名（类 +） 对象类型前缀 + _ + 对象英文名如：uo_process_render cw_process_ancestor2.3.2.1.2 控件对象命名对象类型前缀 + _ + 对象英文名如：pic_background sle_password2.3.2.2 变量命名规范变量类别序号项目前缀备注1全局变量GGlobal2共享变量SShared3实例变量IInstant4局部变量LL

10、ocal5远端变量RRemote2.3.2.2.1 数据变量类型序号项目前缀备注1任意类型AAny2大数据BlobBlob3布尔型BBoolean4字符型CChar,Character5日期型DDate6时间型TTime7日期时间型DTDateTime8小数型DecDec,Decimal9双精度型DBDouble10整型IInt,Integer11长整型LLong12实型RReal13字符串型SString14无符号整型UIUint,UnsignedInt,UnsignedInteger15无符号长整型ULUlong,UnsignedLong2.3.2.2.2 对象变量类型序号项目前缀备注1应

11、用AppApplication2复选框CbxCheckBox3命令按钮CbCommandButton4数据窗口DwDataWindow5下拉列表框DdlbDropDownListBox6带图标下拉列表框DdplbDropDonwPictureListBox7带格式编辑框EmEdistMask8函数对象FoFunction_Object9图表GrGraph10分组框GbGroupBox11水平滚动条HsbHscrollBar12线LnLine13列表框LbListBox14列表视图LvListView15菜单MMenu16多行编辑器MleMultiLineEdit17OLE控件OleOLE18椭

12、圆OvalOval19图片PicPicture20图形按钮PbPictureButton21带图标列表框PlbPictureListBox22无线按钮RbRadioButton23矩形RRectangle24超文本编辑器RteRichTextEdit25圆角矩形RrRoundRectangle26单行编辑器SleSingleLineEdit27静态文本StStaticText28标签TabTab29树状视图TvTreeView30用户对象UoUserObject31垂直滚动条VbVscrllBar32窗口WWindow33连接ConnectionConnection34上下文信息CtinfoC

13、ontextInformation35上下文关键字CtKeywordContextKeyword36数据存储DsDataStore37动态描述区DdsaDynamicDescriptionArea38动态存储区DsaDynamicStagingArea39错误ErrError40InternetInetInet41Internet结果InetResultInternetResult42邮件会晤层MailsessionMailsession43消息MsgMessage44OLE对象OleObjectOLEOject45OLE存储OleStorageOleStorage46OLE流OleStrea

14、mOleStream47管道PipePipeLine48PB对象PboPowerObject49剖面ProfilingProfiling50服务ServiceService51定时器TimingTiming52轨迹树TraceTreeTraceTree53事务TransTransaction54传输TransportTransport2.3.2.2.3 变量命名变量类别 + 数据类型变量/对象类型变量 + _ + 变量英文名如： gs_username lpic_background2.3.3注释书写规定2.3.3.1 PBLa).PBL注释 PBL库的注释必须标明该库的类别及其功能。 格式：

15、库类别（10个汉字，不足用-补齐） + 功能。 如： 公用库-公用函数 业务逻辑-汇缴处理 用户界面-归集查询分析b).PBL内对象注释 PBL内对象的注释应标明该对象所属的业务、作者及其功能。格式：所属业务（10个汉字，不足用-补齐）+ 作者名（3个汉字，不足用-补齐）+ -+ 功能描述 如： 公用函数-惠兴海-以给定分隔符合并字符串 汇缴处理-喻兵-汇缴用户界面，处理正常汇缴业务2.3.3.2 Script注释a).注释符号 / 不许使用/* */作注释符。b).函数注释每个函数都应描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。 格式：/F

16、unction: 函数名/Purpose: 用途/Scope: 作用范围/Args: 入口参数(列表) 类型 传值方式 含义/Returns: 返回值类型 （可确定值列表） 含义/c).非函数注释 注明该模块的作用 格式： / /功能 /d).程序行间注释 在程序行的每一个处理单元前作注释。 格式： /注释e).注释举例/Function: F_FindObject/Purpose: 按照控件名在可视化主对象中查找主对象内的可视化控件。/Scope: Public/Arguments: ls_name String Value 将要查找的控件名/ lpbo_object PowerObject

17、 Value 可视化主对象/ lpbo_find PowerObject Ref 存放并返回查找到的控件,返回NULL则表/ 示可 视化主对象内无控件或可视化主对象不能包含/ 控件/Returns: Boolean True 表示找到该控件/ False 表示未找到该控件/Integer li_loop,li_totalWindow lw_objectUserObject luo_objectString ls_control_nameObject lo_typeli_loop = 1/取得lpbo_object的类型lo_type = lpbo_object.TypeOf()/根据lpbo_

18、object的类型分别处理Choose Case lo_type Case Window!/Window类型 lw_object = lpbo_object li_total = UpperBound(lw_object.control) If li_total 1 Then SetNull(lpbo_find) Return False End If/查找 Do While li_loop = li_total ls_control_name = lw_object.controlli_loop.ClassName() If ls_control_name = ls_name Then lp

19、bo_find = lw_object.controlli_loop Return True End If li_loop + Loop SetNull(lpbo_find) Return False Case UserObject!/UserObject类型 luo_object = lpbo_object If NOT luo_object.objecttype = CustomVisual! Then SetNull(lpbo_find) Return False End If/可视UserObject类型 li_total = UpperBound(luo_object.control

20、) If li_total 1 Then SetNull(lpbo_find) Return False End If/查找 Do While li_loop = li_total ls_control_name = luo_object.controlli_loop.ClassName() If ls_control_name = ls_name Then lpbo_find = luo_object.controlli_loop Return True End If li_loop + Loop SetNull(lpbo_find) Return FalseEnd Choose/非Wind

21、ow和UserObject类型SetNull(lpbo_find)Return False 2.3.3.3 Script书写规范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).枚举值，

22、如：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 换行每一条语句占一行或

23、多行，不许在一行中书写一条以上的语句（即在一行上不能有用;分开的两条或两条以上的语句）。2.3.3.3.6 分节根据程序处理中不同的阶段用空行对各个阶段分节（至少一个空行，最多可有两个连续的空行）。2.3.3.3.7 SQL书写规范a).分行 每个SQL关键字或短语应占一行，关键字和其后的字段、变量、条件表达式等应以Tab键分隔，尽量使关键字后的字段、变量、条件表达式等的第一项垂直对齐。b).顺序 1).操作子句后的字段排列应与字段在数据库中的物理顺序一致 2).WHERE子句后的条件表达式的排列顺序应与FROM子句中的表的排列顺序相对应，条件表达式中的字段出现顺序应与字段在数据库中的物理顺序

24、一致，但是若条件表达式中的字段存在索引，则条件表达式中的字段出现顺序应与字段在索引中的排列顺序一致3.软件系统结构设计3.1 复审数据流、控制流复审需求分析阶段对软件的功能需求的描述（如系统的DFD图和IDEF0图）是否合理和精化。否则，应在本节进行进一步分解和精化。3.2 软件体系结构3.2.1 软件程序结构图3.2.2模块命名规则3.2.2.1 功能编号定义：FXXYY00a).F 1位，代表功能（FUNCTION）；b).XX 2位，代表子系统编号；c).YY 2位，代表子系统下的一级模块编号；d).00 2位，代表二级及二级以下模块的流水编号；3.2.2.2 功能命名定义：操作 + _

25、 + 操作对象名称 如 Edit_Persona).操作 代表实施某一动作，如Edit、Adjust、Query等；b).操作对象名称 代表操作对象，如Person、Rate、Render等；该位可选；3.2.3模块描述3.2.3.1 学校微网站3.2.3.1.1 学校简介：对学校简介和机构进行管理名 称文件、通知、规范、规定的网上收发标识F0101子系统名 称办公管理系统名称系统（OA）接口说明输入文件、通知、规范、规定等的信息输出文件、通知、规范、规定等的信息功能说明通过网上收发文件、通知、规范、规定等。运行环境说明用Lotes Notes实现。调用关系说明调用模块办公管理被调用模块文件、

26、通知、规范、规定的接收、发送3.2.3.1.2 信息公告：学校通知、公告、新闻的展示名 称电子邮件的收发标识F0102子系统名 称办公管理系统名称系统（OA）接口说明输入邮件收发信息输出邮件收发信息功能说明通过Notes实现电子邮件的收发功能。运行环境说明用Lotes Notes实现。调用关系说明调用模块办公管理被调用模块电子邮件的接收、发送3.2.3.2 用户管理3.2.3.2.1 组织机构管理：将所有组织机构统一管理起来，实现学校、班级机构的属性管理，能够通过统一的界面方便的创建、修改、冻结（毕业班级）组织机构名 称文件资料分类登记标识F0201子系统名 称文件资料库管理系统名称系统（OA）接口说明输入文件资料基本信息输出文件资料基本信息功能说明登记文件资料的基本信息，其中级别可分为：国家、省、市、本公司、各部门和分公司、其他，类别可分为：行政制度、质量、安全、其他等。运行环境说明用Lotes Notes实现。调