家校通概要设计说明书

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.复用策略复用策略.2

2、15.数据设计数据设计.225.1 数据字典复审 .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.1 编写目的编写目的在分析管理信息系统的基础上，华迪公司

3、Android 项目小组对该系统进行了概要设计。主要是基于以下目的编写此说明书。1、对系统概要设计的阶段任务成果形成文档，以便阶段验收、评审，最终的文档验收。2、对需求阶段的文档再次确认过程，对前一阶段需求没有做充分或错误的提出修改。3、明确整个系统的功能框架和数据库结构，为下一阶段的详细设计、编码、和测试提供参考依据。4、明确编码规范和命名规范，统一程序界面。预期读者：详细设计人员、概要设计评审小组、研究院领导。1.2 定义定义MIS: 管理信息系统系统: 管理信息系统质量技术交底：对一个工程项目开始时提出的要达到的质量要求。人力强度：一个工程项目每个时间段投入人力的分布。1.3 参考资料参

4、考资料书2.2.范围范围2.1 系统主要目标系统主要目标华迪家校通（Hwadee Families School Communication，简写：Hwadee-FSC）是指利用无线通信技术和网络技术搭建的家校互通平台，为家校之间提供充分、准确、及时的沟通方式，为全面监控学生和学生成长提供有效的途径，该平台运行于移动终端，家长、学 生、教师、领导都可以通过智能手机、平板电脑等媒介进行沟通和信息传递。2.2 主要软件需求主要软件需求2.2.1 家长需求家长需求2.2.1.1 子女情况监控1可以通过平台查看学生考勤、奖罚、评语、成绩、学生管理、作业等信息2.2.1.2 交流和留言功能1能通过文字进

5、行沟通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 信息交流能通过平台与家长、学生进行沟通交流，支持语音。能发布新闻、通知信息，并推送给家长、学

6、生能发布学生活动照片，所有家长均可以浏览和留言。采用高稳定、高扩展性的开发平台，建议使用 Liferay 平台。客户端支持 IOS 和 Android 两种移动操作系统，推荐前期先开发支持 Android 的移动 APP2.3 设计约束、限制设计约束、限制2.3.1（数据库）表编号与命名定义（数据库）表编号与命名定义2.3.1.1 表编号定义：表编号定义：9000a).91 位，表示表的类型；1代表码表2代表数据存放表3临时表4视图2.3.1.2 表命名定义：表命名定义：AB_ + 表的英文名称a).A表示表的性质，无 代表用户表（与业务处理直接相关的表）S代表系统表（为完成业务而建的对用户非

7、透明的表）b).B表示表的类型，C码表（包含唯一代码，一次性生成，很少改动） D数据存放表（业务数据、控制、设置、记录系统信息等）T临时表（程序动态生成）V视图c).表的英文名称表示表的英文名称，可缩写；d).举例用户码表：c_bank系统码表：sc_user2.3.2 编程规范编程规范2.3.2.1 对象命名规范对象命名规范对象类型序号序号项目项目前缀前缀备注备注1复选框CbxCheckBox2命令按钮CbCommandButton3数据窗口DwDataWindow4下拉列表框DdlbDropDownListBox5带图标下拉列表框DdplbDropDonwPictureListBox6带格

8、式编辑框EmEdistMask7函数FFunction8函数对象FoFunction_Object9图表GrGraph10分组框GbGroupBox11水平滚动条HsbHScrollBar12线LnLine13列表框LbListBox14列表视图LvListView15菜单MMenu16多行编辑器MleMultiLineEdit17对象公用函数OFObjectFunction18OLE 控件OleOLE19椭圆OvalOval20图片PicPicture21图形按钮PbPictureButton 22带图标列表框PlbPictureListBox23无线按钮RbRadioButton24矩形R

9、Rectangle25超文本编辑器RteRichTextEdit26圆角矩形RrRoundRectangle27对象私有函数SFSystemFunction28单行编辑器SleSingleLineEdit29静态文本StStaticText30标签TabTab31树状视图TvTreeView32用户对象UoUserObject33垂直滚动条VbVscrllBar34窗口WWindow35管道PipePipeLine36工程PProject37代理ProProxy2.3.2.1.1 PBL 对象命名对象命名（类 +） 对象类型前缀 + _ + 对象英文名如：uo_process_rendercw

10、_process_ancestor2.3.2.1.2 控件对象命名控件对象命名对象类型前缀 + _ + 对象英文名如：pic_backgroundsle_password2.3.2.2 变量命名规范变量命名规范变量类别序号序号项目项目前缀前缀备注备注1全局变量GGlobal2共享变量SShared3实例变量IInstant4局部变量LLocal 5远端变量RRemote2.3.2.2.1 数据变量类型数据变量类型序号序号项目项目前缀前缀备注备注1任意类型AAny2大数据BlobBlob3布尔型BBoolean4字符型CChar,Character5日期型DDate6时间型TTime7日期时间型

11、DTDateTime8小数型DecDec,Decimal9双精度型DBDouble10整型IInt,Integer11长整型LLong12实型RReal13字符串型SString14无符号整型UIUint,UnsignedInt,UnsignedInteger15无符号长整型ULUlong,UnsignedLong2.3.2.2.2 对象变量类型对象变量类型序号序号项目项目前缀前缀备注备注1应用AppApplication2复选框CbxCheckBox3命令按钮CbCommandButton4数据窗口DwDataWindow5下拉列表框DdlbDropDownListBox6带图标下拉列表框D

12、dplbDropDonwPictureListBox7带格式编辑框EmEdistMask8函数对象FoFunction_Object9图表GrGraph10分组框GbGroupBox11水平滚动条HsbHscrollBar 12线LnLine13列表框LbListBox14列表视图LvListView15菜单MMenu16多行编辑器MleMultiLineEdit17OLE 控件OleOLE18椭圆OvalOval19图片PicPicture20图形按钮PbPictureButton21带图标列表框PlbPictureListBox22无线按钮RbRadioButton23矩形RRectang

13、le24超文本编辑器RteRichTextEdit25圆角矩形RrRoundRectangle26单行编辑器SleSingleLineEdit27静态文本StStaticText28标签TabTab29树状视图TvTreeView30用户对象UoUserObject31垂直滚动条VbVscrllBar32窗口WWindow33连接ConnectionConnection34上下文信息CtinfoContextInformation35上下文关键字CtKeywordContextKeyword36数据存储DsDataStore37动态描述区DdsaDynamicDescriptionArea38

14、动态存储区DsaDynamicStagingArea39错误ErrError40InternetInetInet41Internet 结果InetResultInternetResult42邮件会晤层MailsessionMailsession43消息MsgMessage44OLE 对象OleObjectOLEOject45OLE 存储OleStorageOleStorage 46OLE 流OleStreamOleStream47管道PipePipeLine48PB 对象PboPowerObject49剖面ProfilingProfiling50服务ServiceService51定时器Tim

15、ingTiming52轨迹树TraceTreeTraceTree53事务TransTransaction54传输TransportTransport2.3.2.2.3 变量命名变量命名变量类别 + 数据类型变量/对象类型变量 + _ + 变量英文名如：gs_usernamelpic_background2.3.3 注释书写规定注释书写规定2.3.3.1 PBLa).PBL 注释PBL 库的注释必须标明该库的类别及其功能。格式：库类别（10 个汉字，不足用-补齐） + 功能。如：公用库-公用函数业务逻辑-汇缴处理用户界面-归集查询分析b).PBL 内对象注释PBL 内对象的注释应标明该对象所属的

16、业务、作者及其功能。格式：所属业务（10 个汉字，不足用-补齐）+ 作者名（3 个汉字，不足用-补齐）+ -+ 功能描述如：公用函数-惠兴海-以给定分隔符合并字符串汇缴处理-喻兵-汇缴用户界面，处理正常汇缴业务 2.3.3.2 Script 注释注释a).注释符号/ 不许使用/* */作注释符。b).函数注释每个函数都应描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。 格式：/Function:函数名/Purpose: 用途/Scope: 作用范围/Args: 入口参数(列表)类型传值方式含义/Returns: 返回值类型（可确定值列表）含义/c

17、).非函数注释注明该模块的作用格式：/功能/d).程序行间注释在程序行的每一个处理单元前作注释。格式：/注释e).注释举例/Function: F_FindObject/Purpose: 按照控件名在可视化主对象中查找主对象内的可视化控件。/Scope: Public/Arguments:ls_nameStringValue将要查找的控件名/lpbo_objectPowerObject Value可视化主对象/lpbo_findPowerObject Ref存放并返回查找到的控件,返回NULL则表/示可视化主对象内无控件或可视化主对象不能包含/控件/Returns:BooleanTrue表示找

18、到该控件/False表示未找到该控件/Integer li_loop,li_totalWindowlw_object UserObject luo_objectStringls_control_nameObject lo_typeli_loop = 1/取得lpbo_object的类型lo_type = lpbo_object.TypeOf()/根据lpbo_object的类型分别处理Choose Case lo_typeCase Window!/Window类型lw_object = lpbo_objectli_total = UpperBound(lw_object.control)If

19、li_total 1 ThenSetNull(lpbo_find)Return FalseEnd If/查找Do While li_loop = li_totalls_control_name = lw_object.controlli_loop.ClassName()If ls_control_name = ls_name Thenlpbo_find = lw_object.controlli_loopReturn TrueEnd Ifli_loop +LoopSetNull(lpbo_find)Return FalseCase UserObject!/UserObject类型luo_obj

20、ect = lpbo_objectIf NOT luo_object.objecttype = CustomVisual! ThenSetNull(lpbo_find)Return FalseEnd If/可视UserObject类型 li_total = UpperBound(luo_object.control)If li_total 1 ThenSetNull(lpbo_find)Return FalseEnd If/查找Do While li_loop = li_totalls_control_name = luo_object.controlli_loop.ClassName()If

21、 ls_control_name = ls_name Thenlpbo_find = luo_object.controlli_loopReturn TrueEnd Ifli_loop +LoopSetNull(lpbo_find)Return FalseEnd Choose/非Window和UserObject类型SetNull(lpbo_find)Return False2.3.3.3 Script 书写规范书写规范2.3.3.3.1 大小写大小写a).大写以下项目必须用大写书写：1).SQL 关键字，如：INSERT、SELECT、USING 等2).逻辑运算符，如：NOT、AND、OR

22、 等b).小写以下项目必须用小写书写：1).各种对象名 2).各种对象的属性3).各种变量4).数据表拥有者名称，如：dba5).数据表名6).字段名c).匈牙利书写法以下项目必须用匈牙利书写法书写： 1).用于定义变量的对象类型，如 CW_Process_Ancestor2).枚举值，如：KeyF1!,Question!,WriteMode!3).除逻辑运算符之外的所有 PB 关键字4).函数名称（包括系统函数、用户函数、外部函数和存储过程）2.3.3.3.2 局部变量声明的位置局部变量声明的位置局部变量的声明必须写在该模块中所有可执行代码之前（游标定义除外） 。2.3.3.3.3 缩进缩进

23、按照程序处理的层次关系逐级缩进。缩进符：Tab键。不许用空格键缩进。2.3.3.3.4 间隔间隔1). 在定义变量时应在声明类型和变量之间用Tab键分隔，使每一项声明的第一个变量尽可能的垂直对齐。2). 在数学运算符、逻辑运算符的前后两端必须各以一个空格与其两边的部分分隔。2.3.3.3.5 换行换行每一条语句占一行或多行，不许在一行中书写一条以上的语句（即在一行上不能有用;分开的两条或两条以上的语句） 。2.3.3.3.6 分节分节根据程序处理中不同的阶段用空行对各个阶段分节（至少一个空行，最多可有两个连续的空行） 。2.3.3.3.7 SQL 书写规范书写规范a).分行每个 SQL 关键字

24、或短语应占一行，关键字和其后的字段、变量、条件表达式等应以Tab键分隔，尽量使关键字后的字段、变量、条件表达式等的第一项垂直对齐。b).顺序1).操作子句后的字段排列应与字段在数据库中的物理顺序一致2).WHERE 子句后的条件表达式的排列顺序应与 FROM 子句中的表的排列顺序相对应，条件表达式中的字段出现顺序应与字段在数据库中的物理顺序一致，但是若条件表达式中的字段存在索引，则条件表达式中的字段出现顺序应与字段在索引中的排列顺序一致 3.3.软件系统结构设计软件系统结构设计3.1 复审数据流、控制流复审数据流、控制流复审需求分析阶段对软件的功能需求的描述（如系统的 DFD 图和 IDEF0

25、图）是否合理和精化。否则，应在本节进行进一步分解和精化。3.2 软件体系结构软件体系结构3.2.1 软件程序结构图软件程序结构图3.2.2 模块命名规则模块命名规则3.2.2.1 功能编号定义：功能编号定义：FXXYY00a).F1 位，代表功能（FUNCTION） ；b).XX2 位，代表子系统编号；c).YY2 位，代表子系统下的一级模块编号；d).002 位，代表二级及二级以下模块的流水编号；3.2.2.2 功能命名定义：功能命名定义：操作 + _ + 操作对象名称 如 Edit_Persona).操作代表实施某一动作，如 Edit、Adjust、Query 等；b).操作对象名称代表操

26、作对象，如 Person、Rate、Render 等；该位可选；3.2.3 模块描述模块描述3.2.3.1 学校微网站3.2.3.1.1 学校简介：对学校简介和机构进行管理名 称文件、通知、规范、规定的网上收发标识F0101子系统名 称办公管理系统名称系统（OA）输入文件、通知、规范、规定等的信息接口说明输出文件、通知、规范、规定等的信息 功能说明通过网上收发文件、通知、规范、规定等。运行环境说明用 Lotes Notes 实现。调用模块办公管理调用关系说明被调用模块文件、通知、规范、规定的接收、发送3.2.3.1.2 信息公告：学校通知、公告、新闻的展示名 称电子邮件的收发标识F0102子系

27、统名 称办公管理系统名称系统（OA）输入邮件收发信息接口说明输出邮件收发信息功能说明通过 Notes 实现电子邮件的收发功能。运行环境说明用 Lotes Notes 实现。调用模块办公管理调用关系说明被调用模块电子邮件的接收、发送3.2.3.2 用户管理3.2.3.2.1 组织机构管理：将所有组织机构统一管理起来，实现学校、班级机构的属性管理，能够通过统一的界面方便的创建、修改、冻结（毕业班级）组织机构名 称文件资料分类登记标识F0201子系统名 称文件资料库管理系统名称系统（OA）输入文件资料基本信息接口说明输出文件资料基本信息功能说明登记文件资料的基本信息，其中级别可分为：国家、省、市、本

28、公司、各部门和分公司、其他，类别可分为：行政制度、质量、安全、其他等。运行环境说明用 Lotes Notes 实现。调用模块办公管理调用关系说明被调用模块3.2.3.2.2 文件资料分类查询名 称文件资料分类查询标识F0202子系统名 称文件资料库管理系统名称系统（OA）输入查询条件接口说明输出文件资料库信息功能说明通过查询条件，检索各种文件资料信息，并提供浏览功能。运行环境说明用 Lotes Notes 实现。 调用模块办公管理调用关系说明被调用模块3.2.3.2.3 用户管理名 称文件资料维护标识F0203子系统名 称文件资料库管理系统名称系统（OA）输入文件资料修改信息接口说明输出文件资

29、料库信息功能说明通过查询，检索文件资料信息，进行修改维护。运行环境说明用 Lotes Notes 实现。调用模块办公管理调用关系说明被调用模块3.2.3.2.3.1 家长注册：家长通过扫描二维码或到 APP 应用商店搜索下载安装和注册，填写相关用户信息：用户名、密码、关联子女和所在的班级，提交审核后生效，家长注册由子女所在班级班主任审核3.2.3.2.3.2 老师注册：老师账户由管理员进行分配，设定用户名、密码、关联班级3.2.3.2.3.3 领导注册：由管理员设定用户名、密码3.2.3.2.4 权限管理：建设统一的权限管理系统体系，采用 RBAC 模型，将资源及权限信息统一存储，能够进行分级

30、授权3.2.3.3 信息发布3.2.3.3.1 发布通知、公告、新闻等信息。可对这些信息进行管理，包括：发布、修改、删除、置顶名 称技术资料分类登记标识F0301子系统名 称技术资料库管理系统名称系统（OA）输入技术资料基本信息接口说明输出技术资料基本信息 功能说明登记技术资料的基本信息，其中级别可分为：国家、省、市、本公司、各部门和分公司、其他，类别可分为：行政制度、质量、安全、其他等。运行环境说明用 Lotes Notes 实现。调用模块办公管理调用关系说明被调用模块3.2.3.4 交流互动3.2.3.4.1 提供一对一、一对多、多对多交流沟通方式，用户可以进行即时沟通和留言，不只能通过文

31、字进行沟通，还需要能发送语音进行沟通名 称业务信息管理标识F0401子系统名 称经营管理系统名称系统输入业务基本信息接口说明输出业务基本信息功能说明1登记招标基本信息，即业务基本信息。2通过万能查询，可以检索各种业务信息记录，及时了解招标信息。3对已登记的招标信息进行维护。运行环境说明查询可独立成为一个模块调用模块经营管理调用关系说明被调用模块业务信息录入、查询、维护。3.2.3.5 课后作业3.2.3.5.1 任课老师具有布置课后作业的功能，学生和家长都可以看到自己老师布置的作业名 称项目工程概况标识F050101子系统名 称项目管理项目立项系统名称系统输入项目工程概况接口说明输出项目工程信

32、息功能说明登记项目工程概况，即项目基本信息的录入。运行环境说明调用模块项目管理项目立项调用关系说明被调用模块名 称项目工程部概况标识F050102子系统名 称项目管理项目立项系统名称系统输入项目工程部概况接口说明输出项目工程部成员信息 功能说明登记项目工程部成员的基本信息，所担任的角色等信息。运行环境说明调用模块项目管理项目立项调用关系说明被调用模块3.2.3.6 学生活动3.2.3.6.1 老师可以将学生活动信息（文字描述和活动照片）发布到 APP 上，家长可以随时浏览名 称材料价格管理标识F0601子系统名 称材供管理系统名称系统输入材料价格基本信息接口说明输出材料价格基本信息功能说明1登

33、记材料价格信息，并对价格信息进行随时维护。2提供材料价格的综合查询功能（对所有用户都有此查询操作权限） 。其中价格综合查询时，提供相应材料的加权平均价。运行环境说明调用模块材供管理调用关系说明被调用模块材料价格录入、查询、维护3.2.3.8 学生成绩3.2.3.8.1 将学生成绩信息集成到该平台，教务系统（学籍系统）提供学号、学生名称、科目、成绩信息，家长可随时查看学生成绩名 称在职人员信息登记标识F080101子系统名 称人事管理人员信息登记系统名称系统输入在职人员信息接口说明输出在职人员信息功能说明登记在职人员基本信息运行环境说明调用模块人事管理人员信息登记调用关系说明被调用模块名 称离退

34、休人员信息登记标识F080102子系统名 称人事管理人员信息登记系统名称系统接口输入离退休人员基本信息 说明输出离退休人员基本信息功能说明登记离退休人员基本信息运行环境说明调用模块人事管理人员信息登记调用关系说明被调用模块名 称员工工资登记标识F080103子系统名 称人事管理人员信息登记系统名称系统输入员工工资信息接口说明输出员工工资信息功能说明登记公司员工工资基本信息。接收分公司上报的员工的工资数据。运行环境说明各分公司具有独立模块，上报员工的工资数据。调用模块人事管理人员信息登记调用关系说明被调用模块3.2.3.9 学生奖罚3.2.3.9.1 将学生奖罚信息集成到该平台，学工系统（学生管

35、理）提供学号、学生姓名、奖罚信息，家长可及时关注子女的奖罚情况名 称业务信息管理标识F0901子系统名 称设计院信息管理系统名称系统输入设计院业务信息接口说明输出设计院业务信息功能说明1记录设计院的业务信息基本内容。2提供万能查询，检索设计院业务信息。3对业务信息进行维护。运行环境说明调用模块设计院信息管理调用关系说明被调用模块业务信息的录入、查询、维护。3.2.3.10 学生评语3.2.3.10.1 老师可对每位学生进行评价，填室评语，家长随时查看学生评语信息名 称财务报表录入标识F1001子系统名 称财务报表管理系统名称系统输入财务报表信息接口说明输出财务报表信息 功能说明记录公司各部门的

36、财务报表数据。运行环境说明调用模块财务报表管理调用关系说明被调用模块3.3 功能需求追溯功能需求追溯模块1模块2模块3模块4模块5模块6模块7模块8模块9模块10模块11模块12功能需求 1办公管理功能需求 2文件资料库管理功能需求 3技术资料库理功能需求 4经营管理功能需求 5项目管理功能需求 6材供管理功能需求 7设备管理功能需求 8人事管理功能需求 9设计院管理功能需求 10财务报表管理功能需求 11房地产管理功能需求 12系统管理4.4.复用策略复用策略1) 利用已有的在 LOTUS NOTES 开发的文件管理、邮件管理、电子公告栏和 BBS 站模块，对他们进行修改后再利用。2）对已有的 TopADM 进行简化，用到设计院模块。3）利用已有的远程拨号模块 5.5.数据设计数据设计5.1 数据字典复审数据字典复审对需求分析阶段形成的数据字典进行复审和精化。5.2 数据项数据项业务信息表 d_operation_info序号序号数据名称数据名称数据代码数据代码类型类型宽度宽度备注备注1信息编号Info_idC10信息记录的编号2工程编号Project_idC103工程名称Project_nameC404工程地点Projec