新闻发布系统详细设计说明书.doc

软件工程综合设计课程任务分派单 组长用 软件工程综合设计课程任务分派单 组长用 班级 计 041 组别 4 组长姓名 时间 2007 年 11 月 5 日 项目名称 新闻发布系统 阶段名称 详细设计说明书 本次作业每个人负责完成各自的模块详细设计 有关模块间的接口问题要与其它模块负责的同 学进行详细的讨论交流 认真阅读附件中的概要设计说明书 具体设计步骤如下 1 说明子系统模块所包含的单元文件名称及其程序层次结构 2 该模块程序应具有的功能 可采用 IPO 图 即输入 处理 输出图 的形式 详细方 法见教科书 3 7 3 3 用程序流程图 程序框图 或盒图 N S 图 画出控制结构 流程逻辑部分 描述程序 处理过程 详细方法见教科书 6 3 4 用改进的 Jackson 图描绘程序的数据结构 注意实际使用的数据元素彼此间的逻辑关系 详细方法见教科书 6 4 也可以使用层次方框图描绘数据的层次结构 详细方法见教科书 3 7 1 5 详细参照前面的说明书 说明各性能 输入 出项及其限制条件 并写清楚进行单体测试 的计划等 写明本程序的设计中尚未解决而你认为在软件完成之前应解决的问题 如果有的话 注 注 即每个人必须完成报告的第二 三部分 序 号 学号姓名任务名称具体任务内容完成标准起止日期 验收成 绩 1 11041110 9 蒋丹 1 添加新闻 2 修改新闻 3 引言 见上述设计 说明 2007 11 6 211041129徐莉 新闻管理 子系统 1 删除新闻 2 文件上传 见上述设计 说明 2007 11 6 3 11041112 8 项鸿民 1 管理员登录 2 添加目录 见上述设计 说明 2007 11 6 4 11041113 1 颜健 管理员登 录 和分类新 闻 1 修改目录 2 删除目录 见上述设计 说明 完成 报告 2007 11 6 5 11041110 2 陈敏敏 1 新闻首页 2 推荐新闻 3 新闻详情 见上述设计 说明 2007 11 6 6 11041112 0 马杰 前台阅读 子系统 1 阅读评论 2 发表评论 见上述设计 说明 2007 11 6 1 本表由组长为其组员每次上机实践分派任务使用 应认真填写相关任务名称 内容 完成标准 等信息 2 本表在每次任务完成后 由组长按照完成标准验收 并给出每个组员成绩评定 每人平均 70 分 制 除组长保留一份外 应及时上报任课老师 电子和纸质文档同时上报 目 录 1 1 引言引言 1 1 编写目的 1 2 背景 1 3 定义 1 4 参考资料 2 2 程序系统的结构程序系统的结构 3 3 程序设计说明程序设计说明 3 1 程序描述 3 2 功能 3 3 性能 3 4 输人项 3 5 输出项 3 6 算法 3 7 流程逻辑 3 8 接口 3 9 存储分配 3 10 注释设计 3 11 限制条件 3 12 测试计划 1 1 引言 1 1 编写目的 本文档是程序员代码的基础 本文档的读者是设计人员和程序员 1 2 背景 1 待开发的软件系统的名称 新闻发布系统 2 本项目的任务提出者 新闻网站 3 开发者 淮海工学院计算机系 041 班第 4 组 4 用户 新闻网站管理处 1 3 参考资料参考资料 1 ASP 网站开发 2 系统功能说明书 3 需求说明书 4 概要设计说明书 2 程序系统的结构 功能需求与程序的关系如表 2 5 所示 表 2 5 功能需求与程序的关系 功能需求程序单元或模块 实现功能需求 程序层次结构 管理员登陆Administrator Login Unit图 3 添加目录Add List Unit图 3 修改目录Renew List Unit图 3 删除目录Delete List Unit图 3 添加新闻Add News Unit图 1 修改新闻Renew News Unit图 1 删除新闻Delete News Unit图 1 文件上传Document Upload Unit图 1 新闻首页News Home Page图 2 推荐新闻Recommend News图 2 新闻详情News Details图 2 阅读评论Read And Review Unit图 2 发表评论Publish Your Comments Unit图 2 2 新闻管理 News Management Unit 修改新闻 Renew News Unit 删除新闻 Delete News Unit 文件上传 Document Upload Unit 图 1 新闻管理层次结构图 图 2 前台阅读模块 图 3 后台管理模块 3 程序 1 设计说明 徐莉开始 限于篇幅 本程序设计说明中仅以 信息管理子系统 的数据库及存储过程模块进行详细设计 为例说明如何书写程序设计说明 其他模块可参考本设计说明 3 1 程序描述 限于篇幅 本程序设计说明仅以 新闻发布系统管理 为例说明如何书写程序设计说明 其他 模块可参考本设计说明 新闻发布管理系统 用于组建一个新的新闻发布管理 包括客户端和服务端 以及各种新 添加新闻 Add News Unit 3 闻的管理 包括新闻内容的发布 修改 删除和上传 在设计新闻发布过程中 为了便于对新闻发布管理系统的测试 一般首先设计好新闻发布部分 以便可以向数据库中录入部分新闻数据 从而可以设计调试显示新闻列表和浏览新闻部分功能 在 发布新闻时 要选好新闻的类型 然后再发布上去 在添加新闻过程中难免会出现错误 修改新闻是非常重要的 实现修改功能的过程一般是首先 将指定的内容从数据库中读取出来 然后显示在页面的输入框中 然后再进行修改 删除一个新闻信息的第一步 只有当查找到合理的所需删除的新闻内容 才可以建立其隶属的 关系 然后再删除录入新闻消息 关于上传新闻内容也是在原来的新闻内容基础上 先查看是否有 相同的内容 符合上传条件后再上传内容 3 2 功能 说明该程序应具有的功能 可采用 IPO 图 即输入一处理一输出图 的形式 1 添加新闻功能表 2 修改新闻功能表 3 删除新闻功能表 设计者徐莉设计日期 2007 10 审核者审核日期 程序名称添加新闻标识符 Add news 相关数据库 表 newsinfo 输入查找需要添加的新闻类型 输出查找类型成功并添加新闻 程序处理 说明 调用方法 创建本窗体 在数据库中查询所想添加的新闻类型 在数据库中查到该信息后添加它 设计者徐莉设计日期2007 10审核者审核日期 程序名称修改新闻标识符 Update news 相关数据库 表 newsinfo 输入查找需要修改的新闻 输出查找新闻成功并修改 程序处理 说明 调用方法 创建本窗体 在数据库中查询所想修改的新闻信息 在数据库中查到该信息后修改 4 4 文件上传功能表 3 3 性能 在上述关于上传文件中 可以将一个或多个文件同时上传上去 这就取消了每次只可以上传一 个文件的局限性 3 4 输人项 1 新闻标号代码 字符类型 2 新闻名称代码 字符类型 3 上传时间代码 datatime 8 4 所属栏目 整型 5 文件内容 文档类型 6 所属新闻 整型 7 文件路径 varchar 50 8 查看次数 整型 设计者徐莉设计日期 2007 10 审核者审核日期 程序名称删除新闻标识符 Delete news 相关数据库 表 newsinfo 输入查找需要删除的新闻 输出查找数据成功并删除 程序处理 说明 调用方法 创建本窗体 在数据库中查询所想删除的新闻信息 在数据库中查到该信息后删除它 设计者徐莉设计日期 2007 10 审核者审核日期 程序名称文件上传标识符 puton 相关数据库 表 image 输入文件内容包括文本附件和图片 输出上传文件成功 程序处理 说明 调用方法 创建本窗体 找到需上传的文件地址 通过上传页面脚本 可以将文件上传上去 5 3 5 输出项 添加新闻成功 修改新闻成功 删除新闻成功 文件上传成功 3 6 算法 本程序中没有采用特殊的算法 徐莉结束 3 7 流程逻辑 1 添加新闻流程图 查询所添加新闻的类型 是否存在此类 型 添加新闻 保存新闻 添加类型 退出操作 N Y 图 A 添加新闻流程图 2 修改新闻流程图 查找要修改的新闻 修改新闻 是否存在此新闻 退出操作 图 B 修改新闻流程图 6 3 删除新闻流程图 查找要删除的新闻 删除新闻 是否存在此新闻 退出操作 图 C 删除新闻流程图 4 文件上传流程图 查找要上传文件的地址 上传页面脚本 是否存在此地址 退出操作 图 D 删除新闻流程图 3 8 接口 该模块与主模块及其他模块的关系如下 1 该模块直接被主模块调用 添加 修改 删除新闻内容和文件上传 同时进行超连接 2 该模块直接调用数据库连接模块 取得数据库连接 3 9 存储分配 无特殊要求 3 10 注释设计 1 加在程序单元首部 说明本程序的作用 2 对程序中的变量代表的意思 范围进行注释 3 对程序中的函数或过程所起的作用进行注释 7 3 11 限制条件 本程序运行暂时未限制条件 3 12 测试计划 1 若没有要添加新闻的类型时 则在分类管理子模块中添加类型 若是 则满足要求 2 若查找新闻为空 则提示 无此新闻 若是 则满足要求 3 若上传文件地址错误时 则提示 文件地址错误 若是 则满足要求 4 出现写数据库错误 则提示无法连接的具体原因 若是 则满足要求 3 13 尚未解决的问题 本程序的设计中暂时没有尚未解决而设计者认为在软件完成之前应解决的问题 4 程序 2 标识符 设计说明 4 1 程序描述 前台阅读模块的最终目的是能方便地让用户读取到新闻 设计一个界面友好及能及时显示用户 最需要信息的首页是在设计新闻发布系统时需要着重考虑的 在新闻首页 一般将最热门信息和最新 信息放置在最显眼的位置 并提供栏目导航 使用户能随意方便地进入需要的栏目 并能看到栏目的 新闻列表内容 为了使新闻阅读具有趣味性和交互性 需要为新闻添加发表意见添加评论的支持 新 闻评论添加后会跳转到新闻详情页面 在此页面读者可以看到新闻评论列表内容 评论附加在新闻详 细内容后面 4 2 功能 说明该程序应具有的功能 可采用 IPO 图 即输入一处理一输出图 的形式 设计者设计日期审核者审核日期 程序名称新建前台阅读标识符 CreateReadUnit 相关数据库表 输入新闻评论 输出新闻详情 阅读评论 程序处理 说明 调用方法 创建本窗体 当向数据库中存入新的新闻信息时 检查评论的内容是否超出所给的最大 范围 向数据库中插入新的新闻评论信息 8 4 3 性能 本模块对程序性能没有特殊的要求 4 4 输人项 本模块只有发表评论模块有输入项 输入项是读者的评论 其他的模块只是通过点击就可以进 入相应的界面 4 5 输出项 输出项是读者通过点击所得到的相应的界面 包括 新闻的首页 推荐新闻 新闻详情 阅读 评论和发表评论 4 6 算法 本模块只有网页的设计 没有涉及到特殊的算法 4 7 流程逻辑 用图表 例如流程图 判定表等 辅以必要的说明来表示本程序的逻辑流程 前台阅读模块评论部分的逻辑流程图 4 8 接口 该模块与主模块及其他模块的关系 a 该模块直接调用数据库连接模块 取得数据库的连接 b 该模块可以直接被主模块调用生成相应的窗体 4 9 存储分配 无特殊要求 4 10 注释设计 说明准备在本程序中安排的注释 a 加在模块首部的注释 9 b 加在各分枝点处的注释 c 对各变量的功能 范围 缺省条件等所加的注释 d 对使用的逻辑所加的注释等等 4 11 限制条件 本模块无特殊的限制条件 4 12 测试计划 a 发表评论的字数不能超过相应的数字 如果超过了所发表的评论将无法提交 并弹出 超过 所限字数 提示的窗体 如果是则满足条件 b 如果出现点击相应模块无法打开相应的界面 则是数据连接的原因 如果是则满足条件 5 程序 3 设计说明 5 1 程序描述 后台管理模块是是如何对栏目和新闻进行添加 审核 修改 删除 针对系统管理员 总结出 如下需求信息 1 管理员有不同的权限 2 管理员可以对栏目进行增 删 该 3 管理员可以对 新闻进行增 删 该 4 管理员可以对行文模板进行增 删 该 5 管理员可以对新闻进行审核 6 管理员可以对用户进行管理 5 2 功能 说明该程序应具有的功能 可采用 IPO 图 即输入一处理一输出图 的形式 设计者设计日期审核者审核日期 程序名称新建后台管理标识符 CreatemanageUnit 相关数据库表管理员信息表 管理员权限表 输入要更新的目录 输出更新后的目录 程序处理 说明 调用方法 创建本窗体 当向数据库中存入新的目录信息时 是否超出超出管理员的权限范围 5 3 性能 本模块对程序性能没有特殊的要求 5 4 输人项 本模块在管理员登入时需要输入帐号密码 在添加目录时需要输入添加的新目录 在修改删除 10 目录时 用户点击相应界面即可 5 5 输出项 输出项是管理员通过点击所得到的相应的界面 包括 登入成功 目录添加修改删除成功 5 6 算法 本模块只有网页的设计 没有涉及到特殊的算法 5 7 流程逻辑 用图表 例如流程图 判定表等 辅以必要的说明来表示本程序的逻辑流程 后台管理模块评论部分的逻辑流程图 5 8 接口 该模块与主模块及其他模块的关系 管理员登入和分类管理模块直接调用数据库连接模块 取得数据库的连接 5 9 存储分配 无特殊要求 5 10 注释设计 说明准备在本程序中安排的注释 e 加在