公告概要设计说明书.doc

版本版本 项目名称项目名称 通知公告通知公告 概要设计说明书概要设计说明书 南京丹书科技有限公司南京丹书科技有限公司 20112011 年年 1111 月月 项目名称 南京丹书科技有限公司 第 1 页 共 7 页 修订历史记录修订历史记录 日期日期版本版本说明说明作者作者 项目名称 南京丹书科技有限公司 第 2 页 共 7 页 目目 录录 1简介简介 3 1 1目的 3 1 2范围 3 1 3定义 首字母缩写词和缩略语 3 1 4参考资料 3 2总体设计总体设计 4 2 1软件功能描述 4 2 2软件结构 4 2 3外部接口 4 2 3 1软件接口 4 2 3 2其它接口 4 3模块设计模块设计 4 3 1客户管理 4 3 1 1功能说明 4 3 1 2流程图 5 3 1 3数据结构 5 3 1 4类说明 6 3 1 4 1流程图 6 3 1 4 2类说明 6 3 2性能 6 3 3内部接口 7 4故障处理说明故障处理说明 7 项目名称 南京丹书科技有限公司 第 3 页 共 7 页 1 1简介简介 1 1目的目的 对通知公告做详细的概要设计 在开发阶段有较详细的参照 1 2范围范围 本文档适用于产品开发的设计 编码阶段 本文档用于软件设计阶段的概要设计 它的上游是 需求分析说明书 它的下游 是 详细设计说明书 并为 详细设计说明书 提供测试的依据 软件概要设计的范围是 软件系统总体结构设计 全局数据库和数据结构设计 外部 接口设计 主要部件功能分配设计 部件之间的接口设计等方面的内容 该范围应覆盖 需求分析说明书 中的功能点列表 性能点列表 接口列表 1 3定义 首字母缩写词和缩略语定义 首字母缩写词和缩略语 Jdk java 必备的软件包 Tomcat 运行该系统的必备服务器 MySql 数据库 1 4参考资料参考资料 1 用户需求分析说明书 2 数据库设计规范 项目名称 南京丹书科技有限公司 第 4 页 共 7 页 2 2总体设计总体设计 2 1软件功能描述软件功能描述 详细见用户需求说明书 2 2软件结构软件结构 利用公司的框架 左边是树结构 根节点为 通知公告 下面四个子节点 分别为 发布公告 浏览公告 草稿箱 回收站 右边是列表页展现 相对应有 一个操作页面 2 3外部接口外部接口 2 3 1 软件接口软件接口 2 3 2 其它接口其它接口 无 3 3模块设计模块设计 3 1客户管理客户管理 3 1 1 功能说明功能说明 通知公告主要是对企业或公司内部的机构 职员进行公告的发布 字段属性有 公告唯一标识 Id 发布对象 主题 发布内容 有效时间 发布人 公告唯一标识 数据库中对应的唯一标识 ID 也是后面列表页面表单的外键 发布对象 公告发布的对象 不能重名 必填 主题 公告的标题 必填 发布内容 必填 有效时间 在这之前有效 必填 项目名称 南京丹书科技有限公司 第 5 页 共 7 页 发布人 系统当前登录用户 不必填 当前模块要实现的功能 新增 删除 修改 排序 新增和修改 主题名称不能为空 删除 修改公告状态 还原 回收站的功能 修改公告状态 排序 重置数据显示顺序 发布 将编辑好的公告对外发布 3 1 2 流程图流程图 通知公告 发布公告草稿箱回收站浏览公告 3 1 3 数据结构数据结构 表名 通知公告树表 notice str01 字段名称字段名称字段类型字段类型主键主键默认值默认值字段说明字段说明 i idint 是树唯一标识 ID i parentidint 树节点父 ID vc namevarchar 20 树节点名称 vc descvarchar 50 节点的描述 表名 通知公告列表 notice str02 字段名称字段名称字段类型字段类型主键主键默认值默认值字段说明字段说明 i idint 是唯一标识 ID vc namevarchar 20 发布人 vc titlevarchar 255 主题 项目名称 南京丹书科技有限公司 第 6 页 共 7 页 c time1char 19 系统当前时间 c time2char 19 有效时间 infotext 发布内容 zhuangtaiint 2 状态 vc receiveNamevarchar 40 发布对象 3 1 4 类说明类说明 3 1 4 1流程图流程图 通知公告通知公告 实体类数据层表现层业务类 3 1 4 2类说明类说明 实体类实体类 com ds notice NoticeEntity 业务类业务类 com ds notice NoticeLogic 数据层数据层 null 表现层表现层 WebContent oa notice 3 2性能性能 说明对各模块的性能要求 包括精度 时间特性和处理速度 性能设计检查列表 如表 1 1 所示 表 1 1 性能设计检查列表 编号性能名称性能描述输入内容系统响应输出内容是否覆盖 1 2 3 项目名称 南京丹书科技有限公司 第 7 页 共 7 页 3 3内部接口内部接口 无 4 4故障处理说明故障处理说明 统一采用 try catch 错误方法 所有错误最终必须以界面形式向用户说明 1 出错输出信息 在用户使用错误的数据或访问没有权限的数据后 系统给出提示 对不起 你非法使 用数据 没有权限 而且用户的密码管理可以允许用户修改自己的密码 不允许